honeymoose
/
jjwt
mirror of https://github.com/jwtk/jjwt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

Les Hazlewood 2022-04-26 19:30:53 -04:00
parent 7b3cbd8c71
commit 0cf289520d
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Home.md

@ -2,18 +2,18 @@ Welcome to the jjwt wiki!
## Release Instructions:
1. Create a '.x' branch where release changes will be made. Once the release is successful, this branch will be merged into the `master` branch. For example, if `master` is at `0.11.4-SNAPSHOT`, then we'll be making a `0.11.4` release, so we want to create a `0.11.x` branch to represent these changes:
1. Create a staging branch where release changes will be made. Once the release is successful, this staging branch will be merged into the `master` branch. For example, if `master` is at `0.11.4-SNAPSHOT`, then we'll be making a `0.11.4` release, so we want to create a `0.11.4-staging` branch to represent these changes:
```bash
git checkout master && git pull
git checkout -b 0.11.x
git push -u origin # push the new 0.11.x branch to the remote origin server (i.e. GitHub)
git checkout -b 0.11.4-staging
git push -u origin # push the new 0.11.4-staging branch to the remote origin server (i.e. GitHub)
```
1. Ensure all `@since JJWT_RELEASE_VERSION` references are changed to the version you are about to release. Commit/push these changes to the `.x` branch.
1. Ensure all `@since JJWT_RELEASE_VERSION` references are changed to the version you are about to release. Commit/push these changes to the staging branch.
1. Ensure all version references (dependency declarations, etc) in `README.md` have been replaced with the version you are about to release. Commit/push this change to the `.x` branch.
1. Ensure all version references (dependency declarations, etc) in `README.md` have been replaced with the version you are about to release. Commit/push this change to the staging branch.
1. Ensure that CHANGELOG.md has a section for the specific release version (e.g. `0.11.4`) that explains why the release was created. Be careful to ensure a link to the GitHub release as well as a backwards-compatibility section if anything was introduced that was incompatible. Commit/push this change to the `.x` branch.
1. Ensure that CHANGELOG.md has a section for the specific release version (e.g. `0.11.4`) that explains why the release was created. Be careful to ensure a link to the GitHub release as well as a backwards-compatibility section if anything was introduced that was incompatible. Commit/push this change to the staging branch.
1. Squash all changes to a single commit and push to origin:
```bash
@ -73,7 +73,7 @@ Welcome to the jjwt wiki!
1. Ensure MAVEN_OPTS is set properly:
```bash
export MAVEN_OPTS="-Dhttps.protocols=TLSv1.2 -Xmx512m -XX:MaxPermSize=128m"
export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
```
1. Run the release build:
@ -100,6 +100,8 @@ Welcome to the jjwt wiki!
1. Logout.
1. Squash and merge the staging branch (e.g. `0.11.4-staging` as a Pull Request into `master` to ensure mainline development receives all staging changes.
1. Publish a Tweet to announce the release. For example: https://twitter.com/lhazlewood/status/1225170466295271425
That's it! The release should show up in Maven Central in 15 to 30 minutes.