Skip to content

Commit

Permalink
Merge pull request #111 from Fbada006/emmanuelmuturia/task/rectify-do…
Browse files Browse the repository at this point in the history
…cumentation

Rectify Documentation
  • Loading branch information
emmanuelmuturia authored Oct 12, 2024
2 parents 984e2b0 + 3c9603a commit b8351b0
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions wiki/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ The steps are straightforward when doing a release as outline below:

1. Create a release branch in the format of `release/MAJOR.MINOR.PATCH` from `main`. Example `release/1.2.5`. Make sure that you have pulled the latest changes from `main` and that all the necessary PRs have been merged ready for the release.
2. Run the release branch created above and make sure there are no errors. If there are any errors, create an issue, open a PR, and merge against the release branch <span style="color:red">NOT</span> `main`
3. Update the `libVersion` variable in `scripts/publish.gradle.kts` to match the release version as set in the branch name.
4. Ensure that you are on the release branch (locally) as `releaseArtMaker.sh` will fail to execute otherwise. Also, make sure that the release branch exists remotely on GitHub.
5. Grant the Execute permission using the following command: `chmod +x releaseArtMaker.sh`
6. Ensure you have your GitHub Token stored in the **local.properties** file and named **GITHUB_TOKEN**. Please use the [Classic Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) as the [Fine Grained Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens) need a bit of configuration.
7. Run the now executable `releaseArtMaker.sh` using the following command: `./releaseArtMaker.sh`
8. Select your release type from the choices provided using the number that corresponds to it.
9. Write your release notes as you would (you can use the hyphens as was done in the previous release notes) and press ENTER once to move to the next line. Press ENTER twice to complete your input.
10. Confirm your release notes by inputting "y" as prompted and you should get a confirmation message on the same after your release has been created.
11. Go to the [releases](https://github.com/Fbada006/ArtMaker/releases), navigate into your release, and ensure the `Set as the latest release` checkbox at the bottom of the page is selected.
12. Publish the release and wait for the `publish` pipeline to run and upload the artefacts to maven. In case of a failure here, start again from number 2 above and repeat.
13. Open a PR from the release branch to the main branch, get a review, ensure all checks have passed, and merge.
3. Ensure that you are on the release branch (locally) as `releaseArtMaker.sh` will fail to execute otherwise. Also, make sure that the release branch exists remotely on GitHub.
4. Grant the Execute permission using the following command: `chmod +x releaseArtMaker.sh`
5. Ensure you have your GitHub Token stored in the **local.properties** file and named **GITHUB_TOKEN**. Please use the [Classic Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) as the [Fine Grained Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens) need a bit of configuration.
6. Run the now executable `releaseArtMaker.sh` using the following command: `./releaseArtMaker.sh`
7. Select your release type from the choices provided using the number that corresponds to it.
8. Write your release notes as you would (you can use the hyphens as was done in the previous release notes) and press ENTER once to move to the next line. Press ENTER twice to complete your input.
9. Confirm your release notes by inputting "y" as prompted and you should get a confirmation message on the same after your release has been created.
10. Go to the [releases](https://github.com/Fbada006/ArtMaker/releases), navigate into your release, and ensure the `Set as the latest release` checkbox at the bottom of the page is selected.
11. Publish the release and wait for the `publish` pipeline to run and upload the artefacts to maven. In case of a failure here, start again from number 2 above and repeat.
12. Once everything has been successfully completed, update the `libVersion` variable in `scripts/publish.gradle.kts` to match the latest release version as indicated in your release branch name.
13. Open a PR from the release branch to the main branch, get a review, ensure all checks have passed, and merge.
14. That's it!

0 comments on commit b8351b0

Please sign in to comment.