chore: introduce changelog generation #220
Conversation
|
|
||
| ### For generating changelog (for those with NPM publishing rights) | ||
|
|
||
| * [Ruby >= v2.1.0](https://www.ruby-lang.org/en/downloads/) |
There was a problem hiding this comment.
gem install rake is also required on Debian based systems such as Ubuntu and Linux Mint.
There was a problem hiding this comment.
Yeah these would be good to add 👍
| @@ -30,9 +30,10 @@ | |||
| "test:unit": "lerna run test:unit", | |||
| "test:lint": "lerna exec -- ../../node_modules/.bin/prettier --write --print-width 100 --tab-width 2 --no-semi --single-quote --trailing-comma es5 --parser typescript src/**/*.ts", | |||
| "build": "node tools/build.js", | |||
| "changelog": "github_changelog_generator --no-compare-link --bug-labels 'Type:\u0020Bug' --enhancement-labels 'Type:\u0020Feature,Type:\u0020Chore' --include-labels 'Type:\u0020Feature,Type:\u0020Chore,Type:\u0020Bug,Type:\u0020Breaking,Type:\u0020Regression' --user motorcyclets --project motorcycle", | |||
There was a problem hiding this comment.
They are spaces, it doesn't seem to work with actual spaces in their place. It errors trying to read them.
TylorS
force-pushed
the
chore/changelog-generator
branch
from
925a4b8
to
f22f9fe
Compare
README.md
Outdated
|
|
||
| In your terminal, run the following: | ||
|
|
||
| NOTE: `sudo` may be required for all of the following terminal commands -- based |
There was a problem hiding this comment.
Remove:
-- based on where you installed
Ruby.
It's just blah blah.
README.md
Outdated
| gem install github_changelog_generator | ||
| ``` | ||
|
|
||
| In your `.bash_profile`, `.zshrc` or equivalent shell configuration file add the |
There was a problem hiding this comment.
Comma after "configuration file".
README.md
Outdated
| export CHANGELOG_GITHUB_TOKEN=$GITHUB_PERSONAL_ACCESS_TOKEN_GENERATED_ABOVE | ||
| ``` | ||
|
|
||
| and save. In a new terminal you will now be able to successfully run `yarn changelog` |
There was a problem hiding this comment.
Remove "and save." We are not dealing with noob computer users who will generate change logs.
Correct:
In a new terminal, you should now be able to successfully run
yarn changelog
| "docs": "node tools/docs.js && git add **/README.md && git commit -m 'docs(README): rebuild documentation' && git push", | ||
| "release:pre": "yarn test && yarn build", | ||
| "release:post": "yarn docs", | ||
| "release:post": "yarn docs && yarn changelog && git add CHANGELOG.md && git commit -m 'docs(CHANGELOG): rebuild changelog && git push'", |
There was a problem hiding this comment.
Why this docs(CHANGELOG):? It seems so ... well ... unnecessary.
There was a problem hiding this comment.
Just following the convention still in the docs script. Should we look at removing that convention from both scripts in another issue/PR or here?
There was a problem hiding this comment.
Hmm! They need to be removed together. If we follow the one-change policy, then another issue/PR. What do you think?
There was a problem hiding this comment.
Yeah, another issue and PR.
README.md
Outdated
| export CHANGELOG_GITHUB_TOKEN=$GITHUB_PERSONAL_ACCESS_TOKEN_GENERATED_ABOVE | ||
| ``` | ||
|
|
||
| In a new terminal, you will now be able to successfully run `yarn changelog` |
There was a problem hiding this comment.
Not "will", but should. There's no guarantee.
README.md
Outdated
|
|
||
| In your terminal, run the following: | ||
|
|
||
| NOTE: `sudo` may be required for all of the following terminal commands. |
There was a problem hiding this comment.
Correction:
Note:
That is, **Note:**.
README.md
Outdated
|
|
||
| In your terminal, run the following: | ||
|
|
||
| **NOTE**: `sudo` may be required for all of the following terminal commands. |
No description provided.