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 more documentation about multiple release channel approaches #348

Open
JAForbes opened this issue Jun 14, 2022 · 2 comments
Open

Add more documentation about multiple release channel approaches #348

JAForbes opened this issue Jun 14, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@JAForbes
Copy link
Owner

No description provided.

@pygy
Copy link
Contributor

pygy commented Jun 14, 2022

I suppose having a --changelog-branch option would make sense here.

@JAForbes
Copy link
Owner Author

A fine idea, but I really think this library shouldn't operate at that level of abstraction. The key thing is pr-release makes it easy to access the metadata of the release so each project can do this their way. Until I see lots of projects do the same thing I don't want to complicate this tool.

# get all the metadata about the release
npx pr-release extract-changelog --out

# Use it in some project specific script
node scripts/update-main-changelog ./.pr-release/changelog.md

In mithril's case, I think we should just keep the changelog's on their own release channel, and glue them together in the docs build for the html output only. Keep the changelog markdown separate for each channel because they are separate histories. But that's my view, maybe others want to do this cross branch updating thing, and that's fine. But I don't think pr-release should have it as built in behaviour.

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

No branches or pull requests

2 participants