RELEASE.md

Release

This documentation details the release process.

The release process can be done manually or automatically.

Automatic release

The automatic release can be done in two ways:

• By creating and pushing a new tag into the repository. This tag should follow the semantic versioning syntax and should be done on the main branch.
• By triggering the workflow manually.

For both of these options, a pull request in ship mode will be created with the changes for the new version.

Because the pull request is in ship mode, it will be merged automatically by Reviewpad and a new version will be created.

Manual release

Prerequisites

Please make sure that:

1. You are on the main branch of the repository.

git checkout main

2. You have the latest version of main branch.

git pull

3. You don't have local changes.

git status

4. You can build the project.

yarn build

Delete the current version from the documentation

❗ In the following steps we assume that the current version is v4.

1. Navigate into the versioned_docs directory and delete the current version.

rm -rf versioned_docs/version-v4

2. Navigate into the versioned_sidebars directory and delete the current version.

rm versioned_sidebars/version-v4-sidebars.json

3. In the root of the project open the versions.json file and remove the current version.

After the changes the file should look like this:

[
    "v3"
]

Create a new version

❗ In the following steps we assume that the new version is v4.

On your terminal run the following command:

yarn run docusaurus docs:version v4

This command will do the following:

1. Create a copy of the current documentation and add it a new folder version-v4 under versioned_docs.
2. Create a copy of the current sidebars add it as a new file version-v4-sidebars.json under versioned_sidebars.
3. Add the v4 into versions.json file.

Run and built it locally

The next step is to run the documentation locally to make sure everything is working as expected.

yarn start

Make sure that the new version is available in the version selector.

Then, build the project.

yarn build

You should be able to build the project without any errors.

Test the Reviewpad configurations

The project contains a set of Reviewpad configurations used for built-ins showcases and use cases.

If you have updated or added any new Reviewpad configuration please make sure you test it.

For that, you can use the checker.sh script that lives in the scripts directory.

For the argument -e you case use a GitHub event from a Reviewpad GitHub App run.

./scripts/checker.sh <local_location_of_your_reviewpad_cli> <directory_to_look_for_yml_configurations> <github_token> <github_repo> <local_location_of_JSON_file_with_GitHub_event>

e.g.

./scripts/checker.sh ~/reviewpad-cli ./docs GITHUB_TOKEN https://github.com/mascarilha/paddy/pull/1 my_event.json

Commit and push it

The next step is to commit and push these changes into the main branch.

Before committing please add the files that were created by the previous step:

git add .

Then commit the changes following the commit syntax:

git commit -m "chore: update version v4"

After this, you can push the changes into the main branch which will trigger the deployment.

git push origin main

This will deploy the documentation into GitHub pages which will be live at docs.reviewpad.com.

You can check the status of the deployment here.

Update algolia

The last step is to update the search index in algolia.

Go to algolia crawler and click on Restart crawling.