From b53655f23af7d048b935dbeabbc1d4cd1afa44dd Mon Sep 17 00:00:00 2001 From: Julien Date: Thu, 12 Dec 2024 15:29:20 +0100 Subject: [PATCH] Add release instructions to CONTRIBUTING.md (#1509) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I always have to think way too hard about how we do this, and look at old PRs and shell history. Let’s document this! --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5e3c399b40..dc87f3761bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,3 +149,25 @@ If you want to talk with other folks in the Pulumi community (including members of the Pulumi team) come hang out in the `#contribute` channel on the [Pulumi Community Slack](https://slack.pulumi.com/). + +## Release Process + +To release a new version of `pulumi-java`, follow these steps: + +1. Create a new pull request that updates [CHANGELOG.md](./CHANGELOG.md) with + the pending changes from [CHANGLOG_PENDING.md](./CHANGLOG_PENDING.md). Do *not* + remove the pending changes from [CHANGLOG_PENDING.md](./CHANGLOG_PENDING.md) + yet. Merge the PR. + +2. After the pull request is merged, push the release tags to the `main` branch + by running the [`release.sh`](./scripts/release.sh) script. Make sure you have + updated your local checkout of `origin/main` first. + + ```shell + git checkout main + git pull origin main + ./scripts/release.sh v0.20.0 + ``` + +3. Create a new pull request that empties the pending changelog in + [CHANGELOG_PENDING.md](./CHANGELOG_PENDING.md) and merge it. \ No newline at end of file