Skip to content

Commit

Permalink
Merge branch 'main' into label-checker
Browse files Browse the repository at this point in the history
  • Loading branch information
screendriver committed Dec 17, 2023
2 parents 37faeca + c4860a5 commit cbb7bcb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
The main features:

- Writes in a `CHANGELOG.md` from merged GitHub pull requests since the last tag. This works by
- Writes in a `CHANGELOG.md` from merged GitHub pull requests since the last tag (as long as [--stdout](#options) is not provided). This works by
- first getting a list of all tags
- than removing all tags that are not compatible to [semver versioning](http://semver.org/)
- sort the tags
Expand Down Expand Up @@ -137,6 +137,10 @@ The `--sloppy` option defaults to false. When set, it allows `pr-log` to generat

When enabled this option outputs the stacktrace of an error additionally to the error message to `stderr`.

#### --stdout

This option disables writing the changelog into the file `CHANGELOG.md`. Instead it prints the changelog to `stdout`.

### Correct usage makes a clean and complete changelog

If you want your changelog to be complete and clean you have to follow these rules:
Expand Down
1 change: 1 addition & 0 deletions renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"commitMessagePrefix": "⬆️ ",
"labels": ["renovate", "upgrade"],
"rebaseStalePrs": true,
"dependencyDashboard": false,
"lockFileMaintenance": {
"enabled": true,
"automerge": true
Expand Down

0 comments on commit cbb7bcb

Please sign in to comment.