Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update contributing guide #167

Closed
wants to merge 1 commit into from
Closed

update contributing guide #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@
## 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).
Your PAT will need `delete:packages`, `write:packages`, and`repo` permissions.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO - my PAT had these perms, may be able to do a smaller set


If you have a PAT handy you can just do:

```
% echo $YOUR_GITHUB_PAT | docker login ghcr.io -u $YOUR_GITHUB_USERNAME --password-stdin
```

## Step 2. Determine the new point version and create a release branch,
You will also need to be an owner in the dagster-io organization in order to push packages.

## Step 2. Determine the new point version and create a release branch,

```
% git checkout main
% git fetch origin --tags --force
% git tag
% git tag
pex-v0.1
pex-v0.1.14
prha
Expand Down Expand Up @@ -51,7 +54,10 @@ A script does this work:

```

This leaves uncommited changes in the working directory.
Note that `OLD_VERSION` may not be the latest tag printed in step 2. You can find the `OLD_VERSION` by looking
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO - confirm if this is the best way to do this

at the version for `dagster-cloud-action` used in https://github.com/dagster-io/dagster-cloud-action/blob/main/actions/utils/copy_template/action.yml or by looking at the release date for v0.1 and finding the dot version with the same date on the [tags page](https://github.com/dagster-io/dagster-cloud-action/tags)

Running the script leaves uncommited changes in the working directory.

# Commit and tag the new version

Expand Down Expand Up @@ -79,7 +85,7 @@ View changes made by the release script

# Step 6. Promote
Most users point at a dot version tag for the GitHub Action, e.g. `@v0.1` and `@pex-v0.1`.
If you are releasing a fix or non-breaking feature, you want to move this tag so existing users get access to your changes.
If you are releasing a fix or non-breaking feature, you want to move this tag so existing users get access to your changes.

```
# use '-f' to force move the tag, since these tags already exist
Expand Down
Loading