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.

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

Already on GitHub? Sign in to your account

馃Ч Update documentation #147

Merged
merged 13 commits into from Jun 3, 2021
Merged

馃Ч Update documentation #147

merged 13 commits into from Jun 3, 2021

Conversation

pje
Copy link
Member

@pje pje commented Jun 2, 2021

  • Document the release process in CONTRIBUTING.md
  • Add development instructions to CONTRIBUTING.md (adapted from download-artifact)
  • Add a test badge to the README
  • Link to CONTRIBUTING.md in README
  • Unify copy between README.md and action.yml
  • Copy-pasta the CoC from download-artifact

@pje pje requested a review from a team as a code owner June 2, 2021 17:12
CONTRIBUTING.md Outdated
Comment on lines 41 to 55
## Releasing a new version

All the concepts from [the actions/toolkit release docs](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md) apply. Please read that first!

Once the changes are merged into main, a repo maintainer should:

1. Bump the package version by running [`npm version [major|minor|patch]`](https://docs.npmjs.com/cli/v7/commands/npm-version). We adhere to [SemVer 2.0](https://semver.org/spec/v2.0.0.html) to the best of our ability. Commit the changes to `package.json` and `package-lock.json` and push them to main.
1. [Draft a new release](https://github.com/actions/labeler/releases/new) pointing to the ref of the version bump you just made. Publish the release to the marketplace when complete.
1. Finally: update the most recent "shorthand tag" (v1, v2, v3, etc) to point to the specific ref of the release you just made. For example, if we just released `v1.1.0`, we would rewrite the `v1` tag like this:

```
git tag -fa v1 v1.1.0 -m "Update v1 tag to point to v1.1.0"
git push origin v1 --force
```

Copy link
Member Author

Choose a reason for hiding this comment

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

@TingluoHuang How does this sound to you?

Copy link
Member

Choose a reason for hiding this comment

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

I would like to get @thboop to take a look since I haven't done lots of action releases.

@pje pje requested review from TingluoHuang and thboop June 2, 2021 17:18
@pje
Copy link
Member Author

pje commented Jun 2, 2021

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@thboop thboop left a comment

Choose a reason for hiding this comment

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

LGTM with one minor Nit

pje and others added 2 commits June 3, 2021 12:35
Co-authored-by: Thomas Boop <52323235+thboop@users.noreply.github.com>
@pje pje merged commit ffa3fbe into main Jun 3, 2021
@pje pje deleted the update-docs branch June 3, 2021 16:43
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Haini

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

****

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants