You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,18 @@ Releasing
2
2
========
3
3
4
4
1. Bump the VERSION_NAME property in `gradle.properties` based on Major.Minor.Patch naming scheme
5
-
2. Update `CHANGELOG.md`, adding the new release version and release notes
6
-
3. Add your sonatype login information under gradle properties mavenCentralUsername and mavenCentralPassword in your local user gradle.properties file
7
-
4. Run `./gradlew publish` to build the artifacts and publish them to maven
8
-
5. Then run `./commitAndTagRelease.sh Major.Minor.Patch` with your version number
5
+
2. Add your sonatype login information under gradle properties mavenCentralUsername and mavenCentralPassword in your local user gradle.properties file
6
+
3. Run `./gradlew publish` to build the artifacts and publish them to maven
7
+
4. Then run `./commitAndTagRelease.sh Major.Minor.Patch` with your version number
9
8
1. eg "./commitAndTagRelease.sh 3.0.1"
10
9
2. This will make a commit with the given release number and add the version tag
11
10
3. It will then push the tag to github
12
11
1. A github action will automatically run when the tag is pushed to generate a github release for this version
13
12
2. Automated publishing only works if commit is tagged starting with "v". commitAndTagRelease script does this for you when passing a semver version number.
14
13
3. The release will automatically generate release notes from the commits since last release. You may want to manually edit the release notes to add more details.
15
-
4. The script will also open up the branch for a PR in github
16
-
1. You can manually follow up with merging the branch changes when ready, but at this point the release is already public.
14
+
5. The script will also open up the branch for a PR in github
15
+
1. If there is additional relevant information about the release that isn't captured in the commit history you should add it to the PR description as well as to the release summary
16
+
2. Manually merge the PR branch to main, but at this point the release is already public.
0 commit comments