Skip to content

Commit

Permalink
chore(release): provide a way to create a local release with less gru…
Browse files Browse the repository at this point in the history
…nt work (#429)

* docs(contributing): add information to update the changelog

* docs(changelog): add a first draft

it needs to contain the new PRs and only contains a not very nice version of the previous release to have an example

* chore(release): propose a way to locally generate a release
  • Loading branch information
C0ZEN committed Jun 2, 2021
1 parent 5fbbfba commit c2acfb4
Show file tree
Hide file tree
Showing 4 changed files with 1,412 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .versionrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"header": "### Actions Stale Changelog\n"
}
26 changes: 24 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Building and testing
# Building and testing

Install the dependencies.

Expand Down Expand Up @@ -36,10 +36,32 @@ Run the linter and fix (almost) every issue for you :heavy_check_mark:
$ npm lint:all:fix
```

### Before creating a PR
# Before creating a PR

## Build and quality checks

Build, lint, package and test everything.

```bash
$ npm all
```

# Release

Based on [standard-version](https://github.com/conventional-changelog/standard-version).

## Define the new version

You can run `npm run release:dry-run` to create a dry-run, or you can directly run `npm run release` to create a new local release.
It will run `prerelease` beforehand to build and pack everything.

If the `prerelease` succeeded, a bump of version will happen based on the unreleased commits.
It will:

- Update the _package.json_ version field
- Update the _package-lock.json_ version field
- Update the _CHANGELOG.md_ to include the release notes of the new version
- Create a local tag
- Create a commit

If everything generated seems ok for you, you can push your tag by running `git push --follow-tags origin {your-branch-name}`.
Loading

0 comments on commit c2acfb4

Please sign in to comment.