Skip to content

Commit edb38f2

Browse files
committed
docs: Update releasing instructions to include manual steps and language release links
1 parent d6c497e commit edb38f2

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

RELEASING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,26 @@
33

44
## Stable release
55

6-
Stable releases are managed by the [Release GitHub Action](https://github.com/mongodb/awscdk-resources-mongodbatlas/actions/workflows/release.yml). You can release a new CDK version by manually trigger the action.
6+
Stable releases are managed by the [Release GitHub Action](https://github.com/mongodb/awscdk-resources-mongodbatlas/actions/workflows/release.yml). You can release a new CDK version by manually trigger the action ([REMEMBER Manual Steps Below](#manual-steps)).
77

88
![Screenshot 2023-04-20 at 10 35 11](https://user-images.githubusercontent.com/5663078/233325734-0f469045-f91b-436c-8dd5-19d1e8f24c57.png)
99

10+
### Manual Steps
1011
After the action finishes successfully you have to manually release the Go package:
1112
- Go to the [Go repo](https://github.com/mongodb/awscdk-resources-mongodbatlas-go) and check that the latest commit happened now with the same release as in this repo, e.g. `chore(release): v3.0.0`.
1213
- Go to the [Go Repo release page](https://github.com/mongodb/awscdk-resources-mongodbatlas-go/releases).
1314
- Select the latest release that has to be the same as the one in this repo, e.g. `awscdkresourcemongodbatlas/v3.0.0`, name will be like `v3.0.0`, click "Generate release notes" and make sure "Set as latest release" is checked.
1415

16+
Also, to ensure no silent errors, look for the specific `vX.Y.Z` language releases:
17+
- [Javascript](https://www.npmjs.com/package/awscdk-resources-mongodbatlas?activeTab=versions)
18+
- [Java](https://central.sonatype.com/artifact/org.mongodb/awscdk-resources-mongodbatlas/versions)
19+
- [Python](https://pypi.org/project/awscdk-resources-mongodbatlas/#history)
20+
- [Golang](https://github.com/mongodb/awscdk-resources-mongodbatlas-go/releases)
21+
- [Nuget](https://www.nuget.org/packages/MongoDB.AWSCDKResourcesMongoDBAtlas#versions-body-tab)
22+
1523
## Versioning
1624
The release version is determinated based on the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) in that release.
1725

18-
1926
## Release troubleshooting
2027
If the Release Gitub Action fails, it can happen that the new version is published only to some repositories,
2128
but the failing ones are still in the current version.

0 commit comments

Comments
 (0)