Skip to content

Commit 36b66ff

Browse files
committed
Merge branch 'develop' into 2.0.0
2 parents 273177f + ed7bab8 commit 36b66ff

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -74,23 +74,29 @@ First ensure the package is prepared for the release process:
7474
* The branch name in the build pipeline badge
7575
* Ensure the Aparapi version set in .gitlab.yml correctly points to the correct version for the branch.
7676
* Update the changelog file.
77+
* When possible make all changes that are universal to all versions in the develop branch and merge to the others.
78+
* Develop should always have the latest Aparapi version.
7779

7880
Next lets take a few steps to do the actual release:
7981

80-
1. Update everything listed above.
82+
1. Update everything listed above. Any functional changes should be made in develop branch when possible. Make sure develop
83+
points to latest Aparapi version.
8184
2. Checkout the branch for the Aparapi version you are working on, for example `git checkout 2.0.0` or create
8285
a new one if this is for a new version. For new branches make sure they are off of develop. Never add a `v` to the begining.
83-
3. Update the README.md to ensure pipeline badge points to the correct branch for new branches.
84-
4. Update .gitlab-ci.yml to ensure the Aparapi version points to the correct version fpr new branches.
85-
5. Push the branch to the server, make sure pipeline passes, such as `git push origin 2.0.0:2.0.0`.
86-
6. If pipeline passed, create a generic new branch, do not push it, as follows `git checkout -b release`.
87-
7. Update the pipeline badge in the readme to point to the to-be-released repository tag/version.
88-
8. Commit the current changes using a generic commit message such as `build(release): version 1.2.3 revision 4`. But do not push.
89-
90-
7. Create a new tag for the current version with the following command: `git tag -a v1.2.3-4 -m "Version 1.2.3 revision 4"`. Ensure
86+
3. Merge develop into the branch your working on, `git merge develop`.
87+
4. Update the README.md to ensure pipeline badge points to the correct branch.
88+
5. Update .gitlab-ci.yml to ensure the Aparapi version points to the correct version fpr new branches. If this is the latest version
89+
of aparapi you should not need to update this, it should have been done in the first step.
90+
6. Push the branch to the server, make sure pipeline passes, such as `git push origin 2.0.0:2.0.0`.
91+
7. If pipeline passed, create a generic new branch, do not push it, as follows `git checkout -b release`.
92+
8. Update the pipeline badge in the readme to point to the to-be-released repository tag/version.
93+
9. Commit the current changes using a generic commit message such as `build(release): version 1.2.3 revision 4`. But do not push.
94+
10. Create a new tag for the current revision with the following command: `git tag -a v1.2.3-4 -m "Version 1.2.3 revision 4"`. Ensure
9195
tags **always** have the aparapi version followed by revsion.
92-
8. Push the newly created tag to the server: `git push origin v1.2.3-4:v1.2.3-4`.
93-
9. Delete the release branch you created locally `git branch -D release`.
94-
9. If the Aparapi version deployed is the latest then merge master and develop to the earlier aparapi version specific branch, **not**
95-
to the tag you just pushed and not to the temporary release branch. Push master and develop if so.
96-
10. Go to Github and go to the release. Update the description with the changelog for the version.
96+
11. Push the newly created tag to the server: `git push origin v1.2.3-4:v1.2.3-4`.
97+
12. Delete the release branch you created locally `git branch -D release`.
98+
13. If the Aparapi version deployed is the latest then merge develop branch into master, develop branch should already contain latest
99+
Aparapi version from the first step.
100+
14. Ensure the pipeline badge in the readme points to the master branch
101+
15. Push master branch to server.
102+
16. Go to Github and GitLab and go to the releases. Update the description with the changelog for the version.

0 commit comments

Comments
 (0)