Skip to content

Commit

Permalink
Add release instructions to CONTRIBUTING.md (#1509)
Browse files Browse the repository at this point in the history
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!
  • Loading branch information
julienp authored Dec 12, 2024
1 parent f78cf10 commit b53655f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit b53655f

Please sign in to comment.