Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add --prepend option as altenative to prepend-token #172

Merged
merged 2 commits into from
Jul 3, 2020

Conversation

mansona
Copy link
Contributor

@mansona mansona commented Jun 25, 2020

Hi, me again 👋

Thanks again for answering my issue #165 so quickly, and with implementation no less 😱

I noticed you implemented this idea of a "prepend token" which would make it quite challenging to automate the way that I'm hoping to 🤔 it means that after we make a release with a prepend token, we would need to move the prepend token to the top of the file again. Also if anyone forgets to do this while I'm not managing the project then they run the risk of deleting other people's changelogs.

I added a --prepend option that effectively acts like there is a prepend-token at the start of the file at all times. Let me know if you have any questions or if you need me to do anything else to get this merged

src/run.js Outdated Show resolved Hide resolved
@cookpete
Copy link
Owner

I'm curious as to how this works, assuming your changelog has a header or title? Would this not just be adding more and more headers every time you generate?

I feel like instead of --prepend you're better off using --stdout, then you can just pipe the output wherever you like?

@mansona
Copy link
Contributor Author

mansona commented Jun 26, 2020

actually that is a good point... I can see now why you implemented the prepend-token, I didn't understand it before.

Every changelog that I have does not have a dedicated header or paragraph at the top of the changelog. Here is an example of the one I've been testing auto-changelog on: https://github.com/ember-learn/ember-styleguide/blob/master/CHANGELOG.md

Is it common to have titles or descriptions on changelogs? Most of the time I see changelogs as just a list like the one I linked 🤔

Yea I guess you're right about --stdout although trying to prepend to a file with piping can be a bit of a pain and is potentially error prone

@WoodLeg
Copy link

WoodLeg commented Jul 3, 2020

Could be awesome to add this feature 👍

@cookpete cookpete merged commit cc1ef37 into cookpete:master Jul 3, 2020
@cookpete
Copy link
Owner

cookpete commented Jul 3, 2020

Released in 2.2.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants