Skip to content

Commit e26920d

Browse files
Fixing releasing instructions [ci skip] (#3382)
1 parent 3b10743 commit e26920d

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

RELEASING.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ Create a Maven settings file
6767
</settings>
6868
```
6969

70+
Make sure you are using Maven version 3.3 or higher to support the Nexus plugin required to stage a release.
71+
7072
To push a release version
7173
=========================
7274

@@ -87,31 +89,33 @@ To push a release version
8789
git commit -m "Release [VERSION HERE]"
8890
```
8991

90-
6. Make sure you are using Maven version 3.3 or higher to support the Nexus plugin required to stage a release.
92+
6. Create and merge in a PR to reflect the updated project version.
93+
94+
7. Run `git clean -x -f -d` to put the repo in a clean state.
9195

92-
7. To ensure a clean build, remove *all* Maven targets (including subdirectories not handled by `mvn clean`) by running `rm -rf target */target`.
96+
8. Locally build the repo by running `mvn install -DskipTests`.
9397

94-
8. Run `python utilities/stage_sites.py`.
95-
This script checks out `gh-pages` branch of the repository, builds the documentation site and javadocs, copies them to the branch and commits it. This script does not push the docs and it must be done manually on the later step. The script assumes that there is no directory called `tmp_gh-pages` in the repository root, remove that directory, if exists, before running the script.
98+
9. Run `python utilities/stage_sites.py`.
99+
This script checks out `gh-pages` branch of the repository, builds the documentation site and javadocs, copies them to the branch and commits it. This script does not push the docs and it must be done manually on the later step. The script assumes that there is no directory called `tmp_gh-pages` in the repository root. If it is present, remove it before running the script.
96100

97-
9. Check that you are not trying to release a SNAPSHOT build (the artifacts versions do not have "-SNAPSHOT" suffix) and then run `mvn clean deploy -DskipTests=true --settings ~/.m2/settings.xml -P release` command. It will build and deploy artifacts to the staging repository.
101+
10. Check that you are not trying to release a SNAPSHOT build (the artifacts versions do not have "-SNAPSHOT" suffix) and then run `mvn clean deploy -DskipTests=true --settings ~/.m2/settings.xml -P release` command. It will build and deploy artifacts to the staging repository.
98102

99-
10. Run `mvn nexus-staging:release` to release the artifacts.
103+
11. Run `mvn nexus-staging:release` to release the artifacts.
100104

101-
11. Run `cd tmp_gh-pages && git push && cd ..` to push the previously generated docs (step 8).
105+
12. Run `cd tmp_gh-pages && git push && cd ..` to push the previously generated docs (step 8).
102106

103-
12. Run `rm -rf tmp_gh-pages` to remove the generated docs directory from your local machine.
107+
13. Run `rm -rf tmp_gh-pages` to remove the generated docs directory from your local machine.
104108

105-
13. Publish a release on Github manually.
109+
14. Publish a release on Github manually.
106110
Go to the [releases page](https://github.com/GoogleCloudPlatform/google-cloud-java/releases) and open the appropriate release draft. Make sure the "Tag Version" is `vX.Y.Z` and the "Release Title" is `X.Y.Z`, where `X.Y.Z` is the release version as listed in the `pom.xml` files.
107111

108112
Add the commits since the last release into the release draft. Try to group them into sections with related changes. Anything that is a breaking change needs to be marked with `*breaking change*`. Such changes are only allowed for alpha/beta modules and `@BetaApi` features.
109113

110114
Ensure that the format is consistent with previous releases (for an example, see the [0.1.0 release](https://github.com/GoogleCloudPlatform/google-cloud-java/releases/tag/v0.1.0)). After adding any missing updates and reformatting as necessary, publish the draft.
111115

112-
14. Run `python utilities/bump_versions.py next_snapshot patch` to include "-SNAPSHOT" in the current project version (Alternatively, update the versions in `versions.txt` to the correct versions for the next release.). Then, run `python utilities/replace_versions.py` to update the `pom.xml` files. (If you see updates in `README.md` files at this step, you probably did something wrong.)
116+
15. Run `python utilities/bump_versions.py next_snapshot patch` to include "-SNAPSHOT" in the current project version (Alternatively, update the versions in `versions.txt` to the correct versions for the next release.). Then, run `python utilities/replace_versions.py` to update the `pom.xml` files. (If you see updates in `README.md` files at this step, you probably did something wrong.)
113117

114-
15. Create and merge in another PR to reflect the updated project version.
118+
16. Create and merge in another PR to reflect the updated project version.
115119

116120
Improvements
117121
============

0 commit comments

Comments
 (0)