semantic-release / semantic-release/docs

Possibility of Extrating NPM related guidance and link to/from recipes

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
5
Forks
2
Avg merge
1d 15h
Merged PRs (30d)
7

Description

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

Originally posted by @travi in https://github.com/semantic-release/docs/pull/16#discussion_r3326777336

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the recipe document discussed in PR #16 and review how its GitHub Actions and npm guidance is organized. Clarify which higher-level npm material should move elsewhere, then make the recipe open with Actions concepts, link the shared guidance, and retain context-specific details for GitHub Actions, GitLab, and CircleCI.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.