Generate CHANGELOG.md #521
Conversation
|
Can you add an option to filter out tags that are just version numbers with no information. |
|
Can be done programatically. Will remove all "empty" tags then. |
|
Can you add the command you ran to the package.json or readme as documentation ? |
|
I've updated the command in readme. If to be added as an npm script should we use |
readme.markdown
Outdated
| # generating changelog | ||
|
|
||
| ```sh | ||
| npx @r0mflip/logtag -r substack/tape -o CHANGELOG.md -t <github-token> | ||
| ``` |
There was a problem hiding this comment.
i definitely think this should be an npm run-script, and the dev dep added.
There was a problem hiding this comment.
I will move it to npm scripts and add as a devdep, but how do we manage the token in NPM scripts? Iam out of ideas how to do it.
There was a problem hiding this comment.
We'd just assume it's an available environment variable, and error out if it's not present.
|
|
||
|
|
||
| ## [v5.0.0-next.5](https://github.com/substack/tape/releases/tag/v5.0.0-next.5) | ||
| Jordan Harband released this on 2020-03-02 |
There was a problem hiding this comment.
is there a way to link to the github profile, or better npm profile, and be a bit more concise?
There was a problem hiding this comment.
We can point to an npm release like https://www.npmjs.com/package/tape/v/4.13.0 but might become npm specific. Also GitHub tags doesn't seem to correspond to exact semver versions on npm. Tags like v5.0.0 would be tape/v/5.0.0 on npm.
On a side note I was wondering that GitHub might merge all features of npm into itself and make the release of npm and GitHub into a single thing.
There was a problem hiding this comment.
I doubt it; npm is intended to be kept separate.
There was a problem hiding this comment.
Link to npm profile of author? or package?
Concise as in?
There was a problem hiding this comment.
I'd assume the profile of the author?
By "concise" i mean not a whole sentence; maybe:
## [v5.0.0-next.5](https://github.com/substack/tape/releases/tag/v5.0.0-next.5)
<caption>by [ljharb](https://npmjs.com/~ljharb)</caption>or something (not sure how caption renders, maybe <sub>)
|
@r0mflip i've rebased this, and would still like to see it land. Have you had time to make some of the changes we discussed above? also, it'd be nice if the github token was read from the env when present (GITHUB_TOKEN or GH_TOKEN), and if |
Codecov Report
@@ Coverage Diff @@
## master #521 +/- ##
=======================================
Coverage 74.15% 74.15%
=======================================
Files 19 19
Lines 766 766
Branches 146 146
=======================================
Hits 568 568
Misses 198 198 Continue to review full report at Codecov.
|
|
Hi @ljharb. Apologies for all the delay. Got a day job and was unable to work on OSS, and worse my personal laptop died. Inquiring on my end to see if my corp laptop can be used for this, or maybe I'll grab my brother's machine. Will try to get it done during weekend. |
|
No worries, thanks :-) keep me posted. |
|
Hi Jordan, might not be able to work on this. Don't have enough bandwidth to work on this :( |
|
@r0mflip thanks for following up; we'll leave this open in case someone else wants to pick it up (if someone does, please post a link to a branch and i'll pull it into this PR) |
Based on #517
I don't think this might be the expected result, but It's something that we can get from GitHub API
Used https://github.com/r0mflip/logtag to generate changelog.