-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[actions] add release workflow #3223
Conversation
.github/workflows/release.yml
Outdated
- uses: softprops/action-gh-release@v1 | ||
with: | ||
body: ${{ steps.changelog_reader.outputs.changes }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This action will create the release if it doesn't exist, or update it if it does. So all that's needed is to pass the release body to it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we also incorporate the harden-runner? https://github.com/step-security/harden-runner
Here's an example: https://github.com/nvm-sh/nvm/blob/master/.github/workflows/lint.yml#L11-L16
It occurs to me that in our changelog, we use markdown references - which means, if the extracted changelog section doesn't also include the relevant links (which are elsewhere in the document), they won't work. How can we verify this before an actual release? |
Codecov Report
@@ Coverage Diff @@
## master #3223 +/- ##
==========================================
- Coverage 97.67% 97.66% -0.01%
==========================================
Files 121 121
Lines 8507 8518 +11
Branches 3070 3074 +4
==========================================
+ Hits 8309 8319 +10
- Misses 198 199 +1
Continue to review full report at Codecov.
|
Just pushed a change that will grab the common links at the end of the file and append them to the release notes. It required adding an html comment to the changelog so they can be easily found. Hopefully that's not an issue. The results of a test run can be seen here https://github.com/xt0rted/eslint-plugin-react/releases/tag/v7.30.0 I'm not sure how best to handle links inside of the version section. The action is filtering them out for some reason. Maybe we could get a setting added that would skip the filter? Another option is to change how PRs are referenced. Instead of doing |
Issue about the link filter mindsers/changelog-reader-action#52 |
That wouldn't cause them to be autolinked when viewing the markdown directly, which i presume is why that choice was originally made. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
k, let's merge this and give it a shot with v7.29.3 :-)
Looks like it worked! https://github.com/yannickcr/eslint-plugin-react/releases/tag/v7.29.3 thank you! |
Got a couple Dependabot PRs for the new version, everything looks good except for the |
That sounds like a dependabot bug; I'd report it to github. (i don't personally use dependabot; i find renovate to be a much better tool) |
Based on the discussion in #3221 this adds a workflow that runs when tags are pushed and creates/updates a release of the same name.
After some testing it turns out GitHub detects force pushes of tags and automatically points an existing release to the new commit. This means the extra steps to check for an existing release, delete it if found, etc. aren't needed.
With this in place you should be able to:
v2.0.0
tagmain
v2.0.0
tagFixes #3221.