Add releases docs

bluedotimpact · May 19, 2024 · afb498f · afb498f
1 parent ac37e27
commit afb498f
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -69,3 +69,13 @@ CMD [ "start", "--optimized" ]
 2. Install [Node.js](https://nodejs.org/)
 3. Edit files - usually in the `theme` folder, in particular the `components` subfolder
 4. Run `npm run build` to create [`dist/bluedot-keycloak-theme.jar`](./out/bluedot-keycloak-theme.jar) which can be installed as above
+
+## Releases
+
+Versions follow the [semantic versioning spec](https://semver.org/).
+
+To release:
+
+1. Use `npm version <major | minor | patch>` to bump the version
+2. Run `git push --follow-tags` to push with tags
+3. Wait for GitHub Actions to publish to GitHub releases.