Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
42 changes: 42 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# How to release a new RocketLang version

Check notice on line 1 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L1

Expected: [None]; Actual: # 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

Check notice on line 5 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L5

Expected: 1; Actual: 0; Below
```

Check notice on line 6 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L6

Fenced code blocks should be surrounded by blank lines

Check notice on line 6 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L6

Fenced code blocks should have a language specified
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

Check notice on line 12 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L12

Expected: 1; Actual: 0; Below
```
docker run -it --rm -e CHANGELOG_GITHUB_TOKEN -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u flipez -p rocket-lang

Check notice on line 14 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L14

Expected: 80; Actual: 158
```

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.

Check notice on line 17 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L17

Expected: 80; Actual: 158

## 3. Update the documentation

Check notice on line 19 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L19

Expected: 1; Actual: 0; Below
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

Check notice on line 31 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L31

Expected: 80; Actual: 100
```
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.

Check notice on line 37 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L37

Expected: 80; Actual: 89

Commit and push the changes to master.

## 4. Publish the release

Check notice on line 41 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L41

Expected: 1; Actual: 0; Below
On the GitHub release page, update the text of the draft release with the last section of the CHANGELOG.md and publish the release.

Check notice on line 42 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L42

Expected: 80; Actual: 131

Check notice on line 42 in RELEASE.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

RELEASE.md#L42

Files should end with a single newline character