From 0d83f7d36339fe541b582e0249ee4cdd2f2a37b5 Mon Sep 17 00:00:00 2001
From: Felix Woestmann <felix.wostmann@edps.europa.eu>
Date: Fri, 24 Jan 2025 09:33:33 +0100
Subject: [PATCH] feature: add instructions on how to release a new version

---
 RELEASE.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 RELEASE.md

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..3949ad5
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,25 @@
+# How to release a new version of the Website Evidence Collector
+
+1. Before releasing a new version on GitLab, make sure the `glab` CLI is installed.
+2. Open the Repository in the terminal, make sure you are on the main branch and pull the latest changes.
+3. Use `npm version` to increase the version to either a major, minor or patch.
+4. Note the version returned by the tool.
+5. Update the `CHANGLOG.md` using the new version.
+6. Use `git push` or create a Merge Request (and wait till its merged) to bring the new version number to the main branch.
+7. Run `git push --tags`.
+8. Run `npm build`.
+9. Enter build directory with `cd build/`.
+10. Run `npm pack`.
+11. Rename resulting artefact of form `website-evidence-collector-[version].tgz` to `website-evidence-collector.tgz`.
+12. Run:
+    ```bash
+    glab release create [version] './website-evidence-collector.tgz#website-evidence-collector.tgz#package' --ref=main --name="[version] / YYYY-MM-DD"
+    ```
+13. Confirm the prompts using ENTER and choose "Leave Blank" for Release notes.
+14. Check that the Release was created successfully.
+15. Add Release notes in the web interface.
+16. Change the `latest` tag using:
+    ```bash
+    git tag -f latest [new-version]
+    git push --tags -f
+    ```
-- 
GitLab