-
Notifications
You must be signed in to change notification settings - Fork 207
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
Auto generate changelog and readme entries #3537
Open
wjrosa
wants to merge
13
commits into
develop
Choose a base branch
from
dev/auto-generate-changelog-and-readme-entries
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…log update on merge
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this Pull Request:
This PR changes how we update
changelog.txt
andreadme.txt
entries by making it more automated. You can add new entries by runningnpm run changelog
and filling in the required information. Upon merging to the' develop' branch, the entry will automatically merge withreadme.txt
andchangelog.txt
.On a next iteration, we will try to create the entries automatically based on the PR description or title. We will also include the PR ID as part of the changelog entry.
Testing instructions
Code review should be enough. You can also draft another PR with a branch created from this one (
dev/auto-generate-changelog-and-readme-entries
) and test the new command and see the new PR description template.changelog.txt
andreadme.txt
(or does not apply)Post merge
cc @diegocurbelo