Skip to content

Commit 2c3b2ff

Browse files
willdurandrebloor
andauthored
docs: update deployment/releases section (#2289)
Co-authored-by: rebloor <git@sherpa.co.nz>
1 parent 7f0cc63 commit 2c3b2ff

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -331,14 +331,17 @@ If you don't want the page to be labelled as a draft (such as and when it's read
331331
Tags should aim to follow the AMO calendar format: `YYYY.MM.DD` with an optional
332332
`-x` suffix for cherry-picking.
333333

334-
## Deployment
334+
## Deployments/Releases
335335

336336
### Stage Deploys
337337

338338
The site is auto-deployed on commits to `master` to https://extensionworkshop.allizom.org/. You can check the version with [the stage version link](https://extensionworkshop.allizom.org/__version__).
339339

340340
### Production Deploys
341341

342-
Tags matching `^20\d{2}\.\d{2}\.\d{2}(?:-\d+)?$` regular expression will be deployed to https://extensionworkshop.com/. You can check the version on production with [the production version link](https://extensionworkshop.com/__version__).
342+
Tags matching `^20\d{2}\.\d{2}\.\d{2}(?:-\d+)?$` regular expression will be deployed to https://extensionworkshop.com/. You can check the version on production with [the production version link](https://extensionworkshop.com/__version__). A good example tag for a production deployment is `2026.03.03`.
343343

344-
A good example tag for a production deploy would be `2022.03.03`.
344+
When you need to deploy a site version, you must create a git tag following the pattern described. To perform a release, you can use the GitHub Web UI and follow the instructions in [Managing releases in a repository][github-release-docs]. Using the _Generate release notes_ option is recommended, but if you do so, remove the details of any dependencies included in the release. You can take inspiration from the [previous releases][previous releases].
345+
346+
[github-release-docs]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
347+
[previous releases]: https://github.com/mozilla/extension-workshop/releases

0 commit comments

Comments
 (0)