Skip to content

refactor(recipe): improve github actions recipe#16

Merged
babblebey merged 25 commits into
nextfrom
recipe/github-action
May 30, 2026
Merged

refactor(recipe): improve github actions recipe#16
babblebey merged 25 commits into
nextfrom
recipe/github-action

Conversation

@babblebey
Copy link
Copy Markdown
Member

@babblebey babblebey commented May 23, 2026

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

  • Reworked the page flow to be execution-first:
    1. Quick start at the top
    2. Clear publishing path selection
    3. Minimal Node workflow users can copy and run
    4. Deeper context and edge cases afterward
  • Improved navigation with direct links from quick start to relevant sections.
  • Added a practical pitfalls checklist and a release readiness checklist.
  • Modernized guidance around publishing/auth:
    1. Prioritizes trusted publishing (OIDC) and npm provenance
    2. Clarifies token behavior and setup expectations
  • Updated the commit-during-release guidance:
    1. Recommends GitHub App authentication as the preferred approach
    2. Adds a minimal GitHub App token example
    3. Explicitly discourages PAT usage due to security risk
  • Added guidance that the workflow snippet represents a simple/default release flow and points users to the Running semantic-release docs for alternate invocation patterns and non-default setups.

Related Issue

Screenshot/Screencast

screen-capture.68.webm

@vercel
Copy link
Copy Markdown

vercel Bot commented May 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
semantic-release-docs Ready Ready Preview, Comment May 30, 2026 8:47am

Request Review

@babblebey babblebey changed the title refactor(recipe): improve github action recipe refactor(recipe): improve github actions recipe May 23, 2026
@babblebey babblebey requested a review from travi May 23, 2026 19:21
@babblebey babblebey changed the base branch from main to next May 23, 2026 19:24
Copy link
Copy Markdown
Member

@travi travi left a comment

Choose a reason for hiding this comment

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

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

Comment thread src/content/docs/foundation/shareable-configurations.md
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

i'm good with that approach, but might be worth capturing so we remember to revisit

babblebey and others added 2 commits May 29, 2026 22:06
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>
Copy link
Copy Markdown
Member

@travi travi left a comment

Choose a reason for hiding this comment

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

a couple more suggestions, but approving so you can decide if they are worth doing before merging or not

Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Comment thread src/content/docs/recipes/ci-configurations/github-actions.mdx Outdated
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
@babblebey babblebey merged commit 41eb48c into next May 30, 2026
5 checks passed
@babblebey babblebey deleted the recipe/github-action branch May 30, 2026 12:15
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.

2 participants