Skip to content

release: document npm publish process for maintainers #7

@shrey16

Description

@shrey16

Goal

Add maintainer-facing documentation for publishing the npm package safely.

Current state

The repo has a Publish npm package GitHub Actions workflow. It runs on GitHub Release publish or manual dry-run dispatch. It does not publish on ordinary pushes.

Acceptance

  • Document version bump rules.
  • Document creating a GitHub Release such as v0.2.10.
  • Document that manual workflow dispatch defaults to dry-run.
  • Document required NPM_TOKEN repo secret without exposing its value.
  • Include the verification commands maintainers should run before release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsDocumentation and contributor guidancearea: releaseRelease, packaging, updater, or publishing workflowgood first issueA small, well-scoped starter task for contributors

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions