From d480b0303c5d536c654d0142e1f3aa807ac4f3a4 Mon Sep 17 00:00:00 2001 From: rayangler <27821750+rayangler@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:48:01 -0500 Subject: [PATCH] Highlight release warnings (#1319) --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b41507c02..92cc9b067 100644 --- a/README.md +++ b/README.md @@ -100,14 +100,19 @@ By default, the master branch of `docs-landing` will be parsed with the parser v ## Releasing -We have configured an automatic release process using [GitHub Actions](https://github.com/features/actions) that is triggered by [npm-version](https://docs.npmjs.com/cli/version). To release a version, you must have admin privileges in this repo. Then proceed as follows: +We have configured an automatic release process using [GitHub Actions](https://github.com/features/actions) that is triggered by [npm-version](https://docs.npmjs.com/cli/version). To release a version, you must have admin privileges in this repo. + +:warning: This process cannot be completed if the releaser's `origin` points to a fork. + +:warning: Please **do not** create new git tags directly through the GH UI or CLI. Doing so may result in a merge conflict or git tag error when +performing the following instructions. + +Then proceed as follows: 1. On the `main` branch, run `git pull` followed by `npm ci`. 2. Run `npm version [major | minor | patch]`, using [Semantic Versioning](https://semver.org) guidelines to correctly increment the version number. Keep the minor version consistent with [snooty-parser versioning](https://github.com/mongodb/snooty-parser/tags). GitHub Actions will create a new git tag and push it to GitHub. 3. Update the release draft found [here](https://github.com/mongodb/snooty/releases) using the automatically generated [CHANGELOG.md](https://github.com/mongodb/snooty/blob/main/CHANGELOG.md) and publish the release. Keep "pre-release" checked until version 1.0.0. -:warning: This process cannot be completed if the releaser's `origin` points to a fork. - ## Testing Tests can be run using: