Pop-up dictionary browser extension for language learning. Successor to Yomichan. (PERSONAL FORK)
yomitan docs operations deployments.md
2.3 kB

Deployments #

We deploy yomitan to the Firefox and Chrome webstore via two channels -- the dev build and the stable build. We do this via a series of GitHub Actions.

Only collaborators with deployment permissions are allowed to deploy.

Deploying a dev build #

  1. Tag the commit with a version number. Like: git tag 24.4.28.0 HEAD (do this after pulling in the latest changes in master) or git tag 24.4.28.0 abc123

Warning

You can not use leading zeroes in the version tags (e.g. 24.04.28.0). Firefox store does not allow them and the deploy will fail.

  1. Push the tag to origin. git push origin 24.4.28.0
  2. The Create prerelease on tag GH workflow will run and will publish a new release in Releases as well as kick off a workflow each for publishing to Firefox and Chrome.
  3. Find the corresponding publish-chrome-development GH action run and unblock the deployment.
  4. Find the corresponding publish-firefox-development GH action run and unblock the deployment.
  5. Wait anywhere between 5mins to a few hours for the build to show up on the Chrome extension page. Firefox does not have a yomitan dev listing and users would have to down the extension locally from "Assets" section of each release.

Deploying a stable build #

  1. Go to "Releases" and pick a version you want to promote to stable.
  2. On the top right corner click on "Edit" and on the bottom there are two options Set as a pre-release and Set as the latest release. Uncheck Set as a pre-release and check Set as the latest release.
  3. This will trigger the release workflow which will in turn trigger the publish-chrome and publish-firefox GH workflows.
  4. Unblock publish-chrome and publish-firefox respectively and wait 5 mins to a few hours for the extensions to reflect on Chrome and Firefox