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

Separate templates for changelogs and releases #150

Open
sergeysedykh opened this issue Mar 21, 2018 · 4 comments
Open

Separate templates for changelogs and releases #150

sergeysedykh opened this issue Mar 21, 2018 · 4 comments

Comments

@sergeysedykh
Copy link

sergeysedykh commented Mar 21, 2018

As my repo is private, I'd like to keep links to issues in the release notes and remove them from the CHANGELOG.md file.

Any hints?

Thanks a lot for GREN, it's awesome!

@alexcanessa
Copy link
Member

Hello @classyentrepreneur glad you're enjoying it!

Unfortunately, there is not an option that allows this scenario right now.

Something that could help would be to have a --config-file option and have two different npm scripts

@sergeysedykh
Copy link
Author

Something that could help would be to have a --config-file option and have two different npm scripts

I'm afraid, I don't understand :( Would you be so kind to provide some more details on how I could set it up?

Thanks a ton!

@alexcanessa
Copy link
Member

Sorry I'll try to explain better:

Right now there isn't a way of achieving it in a clean way. The solution would be for us to create a --config option to select a different configuration file and therefore templates.
At that point you could run:

# release uses default configuration file
gren release
# changelog uses a different one
gren changelog --config=.grenrc.changelog.js

I've created an issue to address it (#152).


... in the mean time ...

There is a manual and "hacky" way you can achieve this:

You might know that gren can be installed globally and from everywhere.
What you need to do is (assuming you were releasing for this repo):

# "somedir" contains a .grenrc.js file with the configuration for the changelog
cd ~/somedir
# Run gren from that folder. It will use the configuration file available there
gren changelog --username=github-tools --repo=github-release-notes

@sergeysedykh
Copy link
Author

Thanks for the clarification!

I'm afraid, I already have the config file in the project folder used for the release notes :(

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

No branches or pull requests

2 participants