...
Are located in '<code checkout location>/nifi-docs/src/main/asciidoc'
and can be changed by making changes to the ASCIIdoc files and following the code contribution process described in "Providing code or documentation contributions" section of this document.
...
As with other contributions, component level documentation should follow the process described in "Providing code or documentation contributions" section of this document.
...
If you are working on a branch over an extended period of time, it helps to keep your code current with the main branch main
branch to ensure your changes are applied as anticipated and to facilitate the merging process.
...
Steps to merge/close pull requests with two main branches
As NiFi now has a 1.0 x (mastermain
) and 01.x.y (support
) branchbranches, pull requests (PR) must may be applied to both, but typically will only be targetted at main
. Here is a step-by-step guide for committers to ensure this occurs for all PRs.
- Check out the latest master
main
$ git checkout mastermain
- $ git pull upstream mastermain
- Check out the PR (example #327). This will be in
detached-HEAD
state. (Note: You may need to edit the.git/config
file to add thefetch
lines below)
$ git checkout github/pr/327
- Create a branch for the PR
...
$ git commit --amend -s
- Edit the commit file to contain "This closes #327. "
$ git log
- Copy commit id of last commit
- Switch back to the master
main
branch
$ git checkout mastermain
- Merge the changes. You can use
cherry-pick
,merge
, etc.
...
$ git log
- Push to the Apache repository (master
main
branch)
$ git push apache mastermain
- (Optional) Switch to the support branch - the following steps are only required if the change is specifically being targetted for a patch release of an existing build (e.g. a bug fix to create 1.15.3 from the 1.15.2 build)
$ git checkout -t upstreamsupport/01.x.y
- (Optional) Check the status of the branch
$ git log
- (Optional) Apply the changes from the PR branch
$ git cherry-pick <commit id>
- (Optional) Push to the Apache repository (support branch)
$ git push apache 0.x
Anchor | ||||
---|---|---|---|---|
|
...