npmpackage.info

Gathering detailed insights and metrics for semantic-release-npm-github

Other packages similar to semantic-release-npm-github

@auto-canary/npm

8.1.0-canary.789.10408.0

NPM publishing plugin for auto

scratch-semantic-release-config

3.0.0

semantic-release shareable configuration for Scratch

@semantic-release-monorepo/core

2.4.2

Apply semantic-release's automatic publishing to a monorepo

@auto-it/npm

11.3.0

NPM publishing plugin for auto

Gathering detailed insights and metrics for semantic-release-npm-github

semantic-release-npm-github - 5.0.0 | npmpackage.info

semantic-release-npm-github

Shareable configuration automated package publication to NPM and GitHub using semantic-release

5.0.0

MIT

8.10 kB

2.5

Installations

npm install semantic-release-npm-github

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.16.1

NPM Version

9.8.1 Pull Requests

Open

0

Total

2

Closed

2

Issues

Open

0

Total

0

Closed

0

Releases

5.0.0

Updated on Jul 21, 2023

4.0.0

Updated on Mar 01, 2023

3.0.0

Updated on Feb 24, 2022

2.0.0

Updated on Sep 30, 2021

1.0.6

Updated on Sep 02, 2021

1.0.5

Updated on Jul 20, 2021

View All 11 releases

Developer

sinedied

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1 Stars

29 Commits

2 Watchers

2 Branches

2 Contributors

Updated on Jul 21, 2023

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

5.0.0

Package Id

semantic-release-npm-github@5.0.0

Unpacked Size

8.10 kB

Size

3.12 kB

File Count

NPM Version

9.8.1

Node Version

18.16.1

Published on

Jul 21, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

:robot: semantic-release-npm-github

Shareable configuration automated package publication to NPM and GitHub using semantic-release, tailored for OSS projects.

Release workflow

Analyzes commits following the conventional commits spec
- Follows the default angular preset
- Includes chore, docs, refactor and style changes in PATCH releases
Generates or updates changelog
Bumps the version in package.json
Publishes package to NPM
Commits the changes made and creates a git tag with the release version
Creates a GitHub release with the package

Install

Install semantic-release

1npm install --save-dev semantic-release

Install this package:

1npm install --save-dev semantic-release-npm-github

Add a semantic release config in your package.json file:

1{
2  "extends": "semantic-release-npm-github",
3  "branch": "main"
4}

Usage

Once everything is installed, you can test your config with a dry run:

1npx semantic-release --dry-run

What you'll probably want to do next is configure a GitHub workflow to run your tests and publish new versions automatically.

Here's a example workflow configuration that runs your tests and publishes a new version for new commits on main branch:

1name: release
2on:
3  push:
4    branches:
5      - main
6
7jobs:
8  test:
9    name: Run tests
10    runs-on: ubuntu-latest
11    steps:
12      - uses: actions/checkout@v2
13      - uses: actions/setup-node@v1
14        with:
15          node-version: '>=14'
16      - run: |
17          npm ci
18          npm test
19        env:
20          CI: true
21
22  release:
23    name: Publish release
24    needs: test
25    runs-on: ubuntu-latest
26    steps:
27      - uses: actions/checkout@v2
28      - uses: actions/setup-node@v1
29        with:
30          node-version: '>=14'
31      - run: |
32          npm ci
33          npm build --if-present
34        env:
35          CI: true
36      - run: npx semantic-release
37        if: success()
38        env:
39          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
40          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

In addition, for this workflow to work correctly you have to generate an NPM authentication token and set it to the NPM_TOKEN secret in your GitHub repository.

Note on GitHub protected branches

If you're releasing a GitHub protected branch you need to change the git commiter to an owner/admin and allow repo admins to bypass the branch protection (make sure "include administrators" is disabled in the branch protection rules.)

If your repo is under an organisation, you can create a bot account and give it admin rights on the repo. If your repo is under a personal account, you have no choice to make the repo owner the commiter for the release.

Either way, you have to create a GitHub personal access token for the commiter account and give it the "repo" access rights. Then set it to the GH_TOKEN secret in your GitHub repository.

Finally, make these two changes to your workflow:

1...
2    - uses: actions/checkout@v2
3      # Add this to commit with a different account than the one
4      # used for checkout
5      with:
6        persist-credentials: false
7...
8    - run: npx semantic-release
9      if: success()
10      env:
11        # Change the secret used here
12        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
13        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
14        # Add this to set the new commiter for the release
15        GIT_COMMITTER_NAME: admin-or-owner
16        GIT_COMMITTER_EMAIL: associated-email@address.com

Note: GitHub secrets not shared with forks and pull requests, so no one that doesn't have write access to your repo can use of them.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to semantic-release-npm-github

Other packages similar to semantic-release-npm-github

semantic-release-npm-github

Installations

Developer Guide

No

CommonJS

18.16.1

9.8.1

Pull Requests

0

2

2

Issues

0

0

0

Releases

Developer

sinedied

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

:robot: semantic-release-npm-github

Release workflow

Install

Usage

Note on GitHub protected branches

10

10

10

3

0

0

0

0

0

0

0

0

0

0

2.5

/10