How to Enable Semantic Release through Github Actions

Owned by Adam Blackwell (Deactivated)
Last updated: Apr 01, 2021
1 min read

As we have transitioned from Travis CI to GH Actions, this page will guide you on how you can add the semantic release functionality to your repository. If you are an edX employee and would like to migrate the tests please refer to https://openedx.atlassian.net/wiki/spaces/SRE/pages/2038792440 .

Instructions

  • Create a new yaml file with the following path structure .github/workflows/ci.yml. This file will most likely look like ci.yml file

  • Create a new yaml file with the following path structure .github/workflows/release.yml. This file will most likely look like release.yml file

  • The following encrypted secrets are available org-wide:

    • DOCKERHUB_USERNAME

    • DOCKERHUB_PASSWORD

    • PYPI_UPLOAD_TOKEN

    • SEMANTIC_RELEASE_NPM_TOKEN

    • SEMANTIC_RELEASE_GITHUB_TOKEN

  • The ci check will run against the PR or the subsequent pushes to the PR, and once you merge it to master the release check will run on the master branch of your repository