From 1b3a14d86f2bba66f01c7cca54e90d1019dd9089 Mon Sep 17 00:00:00 2001 From: David Boreham Date: Fri, 27 Jan 2023 21:22:43 -0700 Subject: [PATCH] Add release process doc --- docs/release-process.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/release-process.md diff --git a/docs/release-process.md b/docs/release-process.md new file mode 100644 index 00000000..c1c6893f --- /dev/null +++ b/docs/release-process.md @@ -0,0 +1,29 @@ +# Release Process + +## Manually publish to github releases + +In order to build, the shiv and wheel packages must be installed: +``` +$ pip install shiv +$ pip install wheel +``` + +Then: + +1. Define `CERC_GH_RELEASE_SCRIPTS_DIR` +1. Define `CERC_PACKAGE_RELEASE_GITHUB_TOKEN` +1. Run `./scripts/tag_new_release.sh ` +1. Run `./scripts/build_shiv_package.sh` +1. Run `./scripts/publish_shiv_package_github.sh ` +1. Commit the new version file. + +e.g. + +``` +$ export CERC_GH_RELEASE_SCRIPTS_DIR=~/projects/cerc/github-release-api/ +$ export CERC_PACKAGE_RELEASE_GITHUB_TOKEN=github_pat_xxxxxx +$ ./scripts/tag_new_release.sh 1 0 17 +$ ./scripts/build_shiv_package.sh +$ ./scripts/publish_shiv_package_github.sh 1 0 17 +``` +