Update release docs (#258)

* v4.1.2 * update release docs --------- Co-authored-by: Frederik Braun <fbraun+github@mozilla.com>
mozilla · Oct 10, 2024 · c933df1 · c933df1
1 parent bf360a9
commit c933df1
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 10 deletions.
diff --git a/CREATING_A_NEW_RELEASE.md b/CREATING_A_NEW_RELEASE.md
@@ -0,0 +1,24 @@
+# Instructions for creating a new release
+
+# Check everything locally:
+
+-   `npm run test`
+-   `npm run lint`
+
+# Preparing the code
+
+-   Bump version in package.json
+-   git add
+-   git commit
+-   git push to branch
+-   Get code review (branch protection) and then merge
+-   wait for travis results just to be sure.
+
+**At this point people tracking `main` should already get the new version**
+
+# Publish the release as a new version
+
+-   git tag -a x.y.z
+-   npm publish
+-   git push --tags
+-   Go to [https://github.com/mozilla/eslint-plugin-no-unsanitized/releases](https://github.com/mozilla/eslint-plugin-no-unsanitized/releases) to create a new release. Pick the right tag.
diff --git a/NOTES b/NOTES