forked from FooSoft/yomichan
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add operation docs * Add warning <rikaitan.link>Y2MwOGFiMjllM2MyYzBhNzUxMWRkOGRlYTIyNWMyODk4MmVhYTYyMQo=</rikaitan.link>
- Loading branch information
1 parent
7dc6394
commit 0dd8219
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Deployments | ||
|
||
We deploy rikaitan 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. | ||
2. Push the tag to origin. `git push origin 24.4.28.0` | ||
3. The [`Create prerelease on tag`](https://github.com/Ajatt-Tools/rikaitan/actions/workflows/create-prerelease-on-tag.yml) GH workflow will run and will publish a new release in [Releases](https://github.com/Ajatt-Tools/rikaitan/releases) as well as kick off a workflow each for publishing to Firefox and Chrome. | ||
4. Find the corresponding `publish-chrome-development` GH action run and unblock the deployment. | ||
5. Find the corresponding `publish-firefox-development` GH action run and unblock the deployment. | ||
6. Wait anywhere between 5mins to a few hours for the build to show up on the [Chrome extension page](https://chromewebstore.google.com/detail/rikaitan-development-build/pnjdahdadbkhcfamabafkjbjblbgkodk). Firefox does not have a rikaitan 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"](https://github.com/Ajatt-Tools/rikaitan/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`](https://github.com/Ajatt-Tools/rikaitan/actions/workflows/release.yml) 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](https://chromewebstore.google.com/detail/rikaitan/pnjdahdadbkhcfamabafkjbjblbgkodk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/rikaitan/) |