Merge pull request #97 from pangeo-forge/release-docs

Release docs
pangeo-forge · Aug 29, 2023 · e3c2dd1 · e3c2dd1
2 parents b4e918a + 157ae47
commit e3c2dd1
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/development/release.md b/docs/development/release.md
@@ -0,0 +1,17 @@
+# Release
+
+Releases are automated by the `release.yaml` GitHub Workflow,
+which is triggered by tag events.
+
+To cut a new release, those with push permissions to the repo, may run:
+
+```console
+git tag $VERSION
+git push origin --tags
+```
+
+Where `$VERSION` is a three-element, dot-delimited semantic version of the form
+`v{MAJOR}.{MINOR}.{PATCH}`, which is appropriately incremented from the prior tag.
+
+And `origin` is assumed to be the remote corresponding to
+`pangeo-forge/pangeo-forge-runner`.
diff --git a/docs/index.md b/docs/index.md
@@ -24,3 +24,11 @@ tutorial/flink
 
 reference/index
 ```
+
+## Development
+
+```{toctree}
+:maxdepth: 2
+
+development/release
+```