Skip to content

Commit

Permalink
docs(package.json, readme.md): add changelog generation
Browse files Browse the repository at this point in the history
  • Loading branch information
FiddlersCode committed Jan 29, 2020
1 parent ded33a1 commit a94b396
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ After the pre-flight checks have been run, an interactive dialogue will appear f
or else remember `:q!` to quite Vim without saving the file.)
https://github.com/FiddlersCode/leopold/issues/47

Not yet implemented:
- automatic generation of semantic version numbers and changelogs based on your commit messages (hence the enforced style)

#### Push Stage
At the moment, no further checks are run at this stage.

Expand All @@ -96,9 +93,11 @@ In order for a PR to be marked as "able to be merged", the following must be tru
- Branch build has succeeded on Circle CI.

Upon merge, a build will be kicked off on Circle CI's `develop` branch.
If the build passes, the build Docker image will be tagged and pushed to Docker hub.
(Currently builds are tagged as "latest" but need to implement automatic semver
to tag them correctly https://github.com/FiddlersCode/leopold/issues/47).
If the build passes, the built Docker image will be tagged and pushed to Docker hub.
Tags are created by `semantic-release`, and are based on the style-enforced commit message.

Not yet implemented:
- automatic generation of changelogs based on your commit messages

The image is then available to download to any servers that require an update.

Expand Down
18 changes: 16 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,23 @@
},
"release": {
"plugins": [
"semantic-release-docker",
"@semantic-release/commit-analyzer",
"@semantic-release/git",
"semantic-release-docker"
"@semantic-release/release-notes-generator",
[
"@semantic-release/changelog",
{
"changelogFile": "docs/CHANGELOG.md"
}
],
[
"@semantic-release/git",
{
"assets": [
"docs/CHANGELOG.md"
]
}
]
],
"branches": [
"develop"
Expand Down

0 comments on commit a94b396

Please sign in to comment.