diff --git a/docs/development/release.md b/docs/development/release.md new file mode 100644 index 00000000..5b0034c1 --- /dev/null +++ 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 index 557a2b7a..ac5aba16 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,3 +24,11 @@ tutorial/flink reference/index ``` + +## Development + +```{toctree} +:maxdepth: 2 + +development/release +```