feat(release): create RELEASE.md

.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Test
         run: ./coverage.sh
       - name: Codecov
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v3
         with:
-          files: ./coverage.txt
+          file: ./coverage.txt
           token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -3,7 +3,6 @@
 [![goreleaser Status](https://github.com/Flipez/rocket-lang/actions/workflows/release.yml/badge.svg)](https://github.com/Flipez/rocket-lang/actions/workflows/release.yml)
 [![Test Status](https://github.com/Flipez/rocket-lang/actions/workflows/test.yml/badge.svg)](https://github.com/Flipez/rocket-lang/actions/workflows/test.yml)
 [![codecov](https://codecov.io/gh/Flipez/rocket-lang/branch/master/graph/badge.svg)](https://codecov.io/gh/Flipez/rocket-lang)
-[![Maintainability](https://api.codeclimate.com/v1/badges/800d0f48a5b283fc4627/maintainability)](https://codeclimate.com/github/Flipez/rocket-lang/maintainability)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/1615fca430c4489aaf292c0e9bb2e797)](https://www.codacy.com/gh/Flipez/rocket-lang/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Flipez/rocket-lang&utm_campaign=Badge_Grade)
 ![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/Flipez.rocket-lang-support?label=vscode%20extension%20version)
 

RELEASE.md

@@ -0,0 +1,42 @@
+# How to release a new RocketLang version
+
+In order to be ready for the release, have all changes in the main branch.
+
+## 1. Create a tag
+```
+git tag -a v0.23.0 -m v0.23.0
+```
+
+This will run the tests and on success build and publish binaries to a draft release.
+
+## 2. Update the changelog
+```
+docker run -it --rm -e CHANGELOG_GITHUB_TOKEN -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u flipez -p rocket-lang
+```
+
+Locally on main, run the changelog generator and commit + push the new Changelog to main. This can be used for a more comprehensive text in the final release.
+
+## 3. Update the documentation
+Make sure the documentation is up to date
+```
+go run docs/generate.go
+```
+
+Create a new versioned doc, matching the created tag
+```
+yarn docusaurus docs:version v0.23.0
+```
+
+Once created, check `docs/versions.json` if any version can be removed.
+If you decide to remove a version from the list, deleted the corresponding documentation and sidebar
+```
+rm -rf versioned_docs/version-v0.22.0/
+rm versioned_sidebars/version-v0.22.0-sidebars.json
+```
+
+In `docs/docusaurus.config.js`, update the `lastVersion` value with the tag just created.
+
+Commit and push the changes to master.
+
+## 4. Publish the release
+On the GitHub release page, update the text of the draft release with the last section of the CHANGELOG.md and publish the release.