Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding git-cliff to npm #133

Closed
atlj opened this issue Jan 2, 2023 · 0 comments · Fixed by #134
Closed

Adding git-cliff to npm #133

atlj opened this issue Jan 2, 2023 · 0 comments · Fixed by #134
Assignees
@orhun
Labels
feature/request New feature or request

Comments

@atlj
Copy link
Contributor

atlj commented Jan 2, 2023

Feature

It would be nice to be able to download git-cliff from npm. That way Node projects could get git-cliff easily.

Solution

We can publish git-cliff to npm with a simple js wrapper that is able to call git-cliff binaries using spawnSync.

Example

lefthook is a program written in go. They also have a similar feature.
@atlj atlj added the feature/request New feature or request label Jan 2, 2023
@orhun orhun mentioned this issue Jan 6, 2023
Merged
13 tasks
@orhun orhun closed this as completed in #134 Jan 9, 2023
orhun added a commit that referenced this issue Jan 9, 2023
@orhun @atlj
chore(npm): package git-cliff for npm (#133)
b7dd592 
* chore: scaffold a typescript node project

* feat: execute git cliff binary using nodejs

* fix: process doesnt return status code

* fix: optional dependencies are not added to git-cliff

* chore(npm): move NPM package to npm folder

* chore(docker): add NPM package to .dockerignore

* feat(cd): publish NPM package via continuous deployment workflow

* docs: add npm instructions to README

* chore(npm): update package keywords

* chore(cd): publish the NPM package publicly

* style(readme): update NPM section in README.md

Co-authored-by: Burak Güner <[email protected]>
Co-authored-by: Burak Güner <[email protected]>
@radusuciu radusuciu mentioned this issue Mar 31, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@orhun orhun

Labels
feature/request New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(npm): package git-cliff for npm (#133) orhun/git-cliff
2 participants
@atlj @orhun