diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70a5c11..9612915 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,6 +28,46 @@ Here are a few things you can do that will increase the likelihood of your pull - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +## Cutting a new release + +
+ +_Note: these instructions are for maintainers_ + +1. Update the version number in [package.json](https://github.com/actions/go-dependency-submission/blob/main/package.json) and run `npm i` to update the lockfile. +1. Go to [Draft a new + release](https://github.com/actions/go-dependency-submission/releases/new) + in the Releases page. +1. Make sure that the `Publish this Action to the GitHub Marketplace` + checkbox is enabled + +Screenshot 2022-06-15 at 12 08 19 + +3. Click "Choose a tag" and then "Create new tag", where the tag name + will be your version prefixed by a `v` (e.g. `v1.2.3`). +4. Use a version number for the release title (e.g. "1.2.3"). + +Screenshot 2022-06-15 at 12 08 36 + +5. Add your release notes. If this is a major version make sure to + include a small description of the biggest changes in the new version. +6. Click "Publish Release". + +You now have a tag and release using the semver version you used +above. The last remaining thing to do is to move the dynamic version +identifier to match the current SHA. This allows users to adopt a +major version number (e.g. `v1`) in their workflows while +automatically getting all the +minor/patch updates. + +To do this just checkout `main`, force-create a new annotated tag, and push it: + +``` +git tag -fa v4 -m "Updating v4 to 4.0.1" +git push origin v4 --force +``` +
+ ## Resources - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) diff --git a/package-lock.json b/package-lock.json index eaade2a..9a8b455 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "go-dependency-submission", - "version": "2.0.1", + "version": "2.0.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "go-dependency-submission", - "version": "2.0.1", + "version": "2.0.2", "license": "ISC", "dependencies": { "@actions/core": "^1.9.1", diff --git a/package.json b/package.json index 2852d12..60a64cc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "go-dependency-submission", - "version": "2.0.1", + "version": "2.0.2", "description": "Go Dependency Submission", "main": "dist/index.js", "scripts": {