npmpackage.info

github-release-from-changelog

Create GitHub releases from your changelog

2.1.1

MIT

JavaScript

Installations

npm install github-release-from-changelog

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

12.11.1

NPM Version

6.11.3 Pull Requests

Open

1

Total

20

Closed

3

Merged

16

Issues

Open

1

Total

9

Closed

8

Releases

2.1.1

Published on 18 Feb 2020

2.1.0

Published on 20 Sept 2019

2.0.0

Published on 20 Sept 2019

1.3.2

Published on 07 Jun 2018

1.3.1

Published on 22 Jan 2018

1.3.0

Published on 06 Dec 2017

View all 13 releases

Contributors

Unable to fetch Contributors

View all 6 contributors

Languages

JavaScript

JavaScript (100%)

Developer

MoOx

Download Statistics

Total Downloads

2,756,955

Last Day

2,522

Last Week

11,553

Last Month

53,433

Last Year

760,042

GitHub Statistics

64 Stars

70 Commits

10 Forks

3 Watching

2 Branches

6 Contributors

Maintainers

Package Meta Information

Latest Version

2.1.1

Package Id

github-release-from-changelog@2.1.1

Size

4.80 kB

NPM Version

6.11.3

Node Version

12.11.1

Publised On

18 Feb 2020

Total Downloads

Cumulative downloads

Total Downloads

2,756,955

Last day

-14.4%

2,522

Compared to previous day

Last week

-9.6%

11,553

Compared to previous week

Last month

-20.9%

53,433

Compared to previous month

Last year

-10.2%

760,042

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

grizzly minimist

Dev Dependencies

husky npmpub prettier pretty-quick

Versions

github-release-from-changelog

Create GitHub releases from CHANGELOG.md

This tool edits the git tag on GitHub and create a GitHub release with the correct changelog section.

You need:

a changelog file (various filenames supported automatically or specified via --filename option) with markdown titles that start with the version (eg: # 1.2.0, ## v1.2.0, # [1.2.0...)
a package.json with a version field.
a git tag with the corresponding version in either X.Y.Z or vX.Y.Z formats.
a GITHUB_TOKEN as an env var. See https://github.com/MoOx/npmpub#requirements for instructions.

Included in npmpub !

Install

1npm install github-release-from-changelog

Usage

1github-release-from-changelog [--filename CustomChangelog.md]

Options

`--filename`

Specify your own filename

`--dryRun`

Test what the release will looks like

`--debug`

Display parsing information

Advanced Installation and Usage

github-release-from-changelog is fully integrated in npmpub. Please follow the instructions at https://github.com/MoOx/npmpub#install to install and use it. npmpub automatically calls github-release-from-changelog by default.

github-release-from-changelog also plays well with other publishing tools such as release-it. One can create a release using release-it (which also updates package.json, but does not free you from maintaining CHANGELOG.md for yourself) and then use github-release-from-changelog to create the release on GitHub.

CONTRIBUTING

⇄ Pull requests and ★ Stars are always welcome.
For bugs and feature requests, please create an issue.

CHANGELOG

See CHANGELOG.md

LICENSE

The license is MIT. See LICENSE.

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.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

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

Token-Permissions

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

0

Maintained

Determines if the project is "actively maintained".

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

Branch-Protection

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

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-01-27

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 github-release-from-changelog

github-release-from-cc-changelog

2.3.0

Create/update Github release notes from a CHANGELOG

@auto-it/package-json-utils

11.3.0

Shared utilities for parsing information from a package.json

@femessage/github-release-notes

0.19.0

Create a release from a tag and uses issues or commits to creating the release notes. It also can generate a CHANGELOG.md file based on the release notes (or generate a brand new).

semantic-release-gitmoji

1.6.8

Different from conventional changelog, Gitmoji commits are used to determine a release type and generate release notes.