Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixing releasing instructions [ci skip] #3382

Merged
merged 2 commits into from
Jun 18, 2018
Merged

Fixing releasing instructions [ci skip] #3382

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6549b6
Fixing releasing instructions
garrettjonesgoogle Jun 14, 2018
e21a276
PR feedback
garrettjonesgoogle Jun 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ Create a Maven settings file
</settings>
```

Make sure you are using Maven version 3.3 or higher to support the Nexus plugin required to stage a release.

To push a release version
=========================

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

6. Make sure you are using Maven version 3.3 or higher to support the Nexus plugin required to stage a release.
6. Create and merge in a PR to reflect the updated project version.

7. Run `git clean -x -f -d` to put the repo in a clean state.

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

8. Run `python utilities/stage_sites.py`.
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.
9. Run `python utilities/stage_sites.py`.
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.

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.
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.

10. Run `mvn nexus-staging:release` to release the artifacts.
11. Run `mvn nexus-staging:release` to release the artifacts.

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

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

13. Publish a release on Github manually.
14. Publish a release on Github manually.
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.

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.

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.

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.)
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.)

15. Create and merge in another PR to reflect the updated project version.
16. Create and merge in another PR to reflect the updated project version.

Improvements
============
Expand Down