From 1d23ba6684c8ecb07a05dd99586791d869c7a376 Mon Sep 17 00:00:00 2001 From: Maxime Armstrong Date: Thu, 9 May 2024 13:33:30 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- .gitignore | 5 ++++- CONTRIBUTING.md | 6 ++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index b9640b28..9a0991dc 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,7 @@ __pycache__/ src/pex-builder/build # locally built wheels for Dockerfile.dagster-manylinux-builder -wheels/*whl \ No newline at end of file +wheels/*whl + +# PyCharm IDE Config files +.idea/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35382d39..b3b18447 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Steps to release +**Note**: These steps can also be used to release a docker-cloud-action image to test your changes. + ## Step 1. Log into docker ghcr.io See [authenticate to GHCR with a PAT](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry). @@ -42,7 +44,7 @@ The point version is the next unused `v0.1.*` version, eg `v0.1.22` above. Creat ## Step 3. Build and deploy a new docker-cloud-action image, a new dagster.cloud.pex and update code references to docker -A script does this work: +A script does this work. **Note**: a virtual environment using Python3.8 is required to run the script. ``` # Note no 'v' prefix @@ -51,7 +53,7 @@ A script does this work: ``` -This leaves uncommited changes in the working directory. +This leaves uncommitted changes in the working directory. # Commit and tag the new version