diff --git a/CHANGELOG.md b/CHANGELOG.md index ec7c1c8e..b83711cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,4 @@ +# DEPRECATED - please from version 2.12.2 check github realase notes # Changelog All notable changes to this project will be documented in this file. diff --git a/RELEASE.md b/RELEASE.md index 035cc94a..7f0d94b2 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -9,12 +9,10 @@ Use this checklist to create a new release of `circles-myxogastria` which gets d 3. `npm test` to ensure that all tests pass locally. 4. `git push` and verify all tests pass on all CI services. 5. Read the git history since the last release, for example via `git --no-pager log --oneline --no-decorate v1.8.0^..origin/main` (replace `v1.8.0` with the last published version). -6. Condense the list of changes into something user-readable and write it into the `CHANGELOG.md` file with the release date and version, following the specification here on [how to write a changelog](https://keepachangelog.com/en/1.0.0/). Make sure you add references to the regarding PRs and issues. -7. Commit the `CHANGELOG.md` changes you've just made. -8. Create a git and npm tag based on [semantic versioning](https://semver.org/) using `npm version [major | minor | patch]`. -9. `git push origin main --tags` to push the tag to GitHub. -10. `git push origin main` to push the automatic `package.json` change after creating the tag. -11. [Create](https://github.com/CirclesUBI/circles-myxogastria/releases/new) a new release on GitHub, select the tag you've just pushed under *"Tag version"* and use the same for the *"Release title"*. For *"Describe this release"* copy the same information you've entered in `CHANGELOG.md` for this release. See examples [here](https://github.com/CirclesUBI/circles-myxogastria/releases). +6. Create a git and npm tag based on [semantic versioning](https://semver.org/) using `npm version [major | minor | patch]`. +7. `git push origin main --tags` to push the tag to GitHub. +8. `git push origin main` to push the automatic `package.json` change after creating the tag. +9. [Create](https://github.com/CirclesUBI/circles-myxogastria/releases/new) a new release on GitHub, select the tag you've just pushed under *"Tag version"* and use the same for the *"Release title"*. For "Describe this release" make sure all the important information is there. Correct typos and re-word commits if necessary. See examples [here](https://github.com/CirclesUBI/circles-myxogastria/releases). ## Deploy release on Netlify