Skip to content

Commit

Permalink
Add link to release-it + Github Actions walk-through video
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Apr 3, 2023
1 parent bf6aa23 commit 3f379ff
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ Per-project installation as shown above is recommended, but global installs are
- From npm: `npm install -g release-it`
- From Homebrew: `brew install release-it`

## GitHub Actions

Want to use release-it with GitHub Actions to fully automate the whole process? Enjoy this great walk-through:
[How to use GitHub Actions & Release-It to Easily Release Your Code](https://www.youtube.com/watch?v=7pBcuT7j_A0) (by
[David from Kodaps](https://twitter.com/KodapsAcademy)).

→ See [Continuous Integration environments](./docs/ci.md) for more details.

## Configuration

Out of the box, release-it has sane defaults, and [plenty of options](./config/release-it.json) to configure it. Most
Expand Down
4 changes: 4 additions & 0 deletions docs/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ jobs:
The `fetch-depth: 0` option is only necessary when the Git history is required e.g. if using a plugin such as
[@release-it/conventional-changelog](https://github.com/release-it/conventional-changelog).

If you enjoy watching a video, [David from Kodaps](https://twitter.com/KodapsAcademy) created a great walk-through
including setting up npm and GitHub tokens:
[How to use GitHub Actions & Release-It to Easily Release Your Code](https://www.youtube.com/watch?v=7pBcuT7j_A0)

## npm

To publish a package to the (or any) npm registry from within a CI or CD environment such as Travis or Circle, make the
Expand Down

0 comments on commit 3f379ff

Please sign in to comment.