Skip to content

Commit aeab9f8

Browse files
authored
Merge pull request #106 from advanced-security/juxtin/prep-412
Update version to 4.1.2 and update release instructions
2 parents 973a8cf + bc43a53 commit aeab9f8

File tree

4 files changed

+43
-129
lines changed

4 files changed

+43
-129
lines changed

.github/workflows/release.yml

Lines changed: 0 additions & 126 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,46 @@ Here are a few things you can do that will increase the likelihood of your pull
2424
- 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.
2525
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
2626

27+
## Cutting a new release
28+
29+
<details>
30+
31+
_Note: these instructions are for maintainers_
32+
33+
1. Update the version number in [package.json](https://github.com/advanced-security/maven-dependency-submission-action/blob/main/package.json) and run `npm i` to update the lockfile. This is also a good time to make sure that the `dist/index.js` file is up to date by running `npm run build`.
34+
2. Go to [Draft a new
35+
release](https://github.com/advanced-security/maven-dependency-submission-action/releases/new)
36+
in the Releases page.
37+
3. Make sure that the `Publish this Action to the GitHub Marketplace`
38+
checkbox is enabled
39+
40+
<img width="481" alt="Screenshot 2022-06-15 at 12 08 19" src="https://user-images.githubusercontent.com/2161/173822484-4b60d8b4-c674-4bff-b5ff-b0c4a3650ab7.png">
41+
42+
4. Click "Choose a tag" and then "Create new tag", where the tag name
43+
will be your version prefixed by a `v` (e.g. `v4.1.2`).
44+
5. Use a version number for the release title (e.g. "4.1.2").
45+
46+
<img width="700" alt="Screenshot 2022-06-15 at 12 08 36" src="https://user-images.githubusercontent.com/2161/173822548-33ab3432-d679-4dc1-adf8-b50fdaf47de3.png">
47+
48+
6. Add your release notes. If this is a major version make sure to
49+
include a small description of the biggest changes in the new version.
50+
7. Click "Publish Release".
51+
52+
You now have a tag and release using the semver version you used
53+
above. The last remaining thing to do is to move the dynamic version
54+
identifier to match the current SHA. This allows users to adopt a
55+
major version number (e.g. `v1`) in their workflows while
56+
automatically getting all the
57+
minor/patch updates.
58+
59+
To do this just checkout `main`, force-create a new annotated tag, and push it:
60+
61+
```
62+
git tag -fa v4 -m "Updating v4 to 4.1.2"
63+
git push origin v4 --force
64+
```
65+
</details>
66+
2767
## Resources
2868

2969
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "maven-dependency-submission-action",
3-
"version": "4.1.1",
3+
"version": "4.1.2",
44
"description": "Submit Maven dependencies to GitHub dependency submission API",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)