refactor(recipe): improve github actions recipe#16
Conversation
…ted links and descriptions
…tup and configuration
…on pitfalls checklist
… GitHub Actions guide
…tions quick start section
…rkflow configuration
…ease outside the normal workflow
…TOKEN and introduce GitHub App authentication example
…ation options for semantic-release
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
travi
left a comment
There was a problem hiding this comment.
not all of these need to be considered blocking, but i think there are some things that could be adjusted before we move this forward
There was a problem hiding this comment.
one general thought about this file: it feels very node heavy, possibly more than it should be. while publishing npm packages is almost certainly our most common use-case, i feel like it maybe distracts from this being a recipe for github actions in the general sense. the concepts covered here are important, but some also apply to gitlab or circle-ci. i think we should adjust so the doc at least opens with more of an actions focus and maybe then follows into the node focus, making it clear that it is the most common or simplest example of releasing from actions. however, i do wonder if some of the higher-level npm guidance should be elsewhere and linked to from here and just highlighting the specifics of how actions factors in within this context. that way it could also be linked to from the gitlab and circle recipes and have each of those highlight the specific details for their contexts, too.
i dont feel like this needs to block getting this iteration merged, so i'd be ok with thinking through this as a follow up
There was a problem hiding this comment.
I can relate to that thought, I believe this is coming from the "package release" tool lens which makes npm feel most primary, and considering that we have npm packed default.
I'd suggest we go the route of finishing up on the other recipe pages, and examine whether there's something we can extract or so.
There was a problem hiding this comment.
i'm good with that approach, but might be worth capturing so we remember to revisit
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
travi
left a comment
There was a problem hiding this comment.
a couple more suggestions, but approving so you can decide if they are worth doing before merging or not
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
This PR revamps the GitHub Actions recipe page to be more action-oriented, easier to scan, and aligned with current semantic-release security guidance.
Notable Changes
Related Issue
Screenshot/Screencast
screen-capture.68.webm