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

Auto generate changelog and readme entries #3537

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from

Conversation

wjrosa
Copy link
Contributor

@wjrosa wjrosa commented Oct 23, 2024

Changes proposed in this Pull Request:

This PR changes how we update changelog.txt and readme.txt entries by making it more automated. You can add new entries by running npm run changelog and filling in the required information. Upon merging to the' develop' branch, the entry will automatically merge with readme.txt and changelog.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.


  • Covered with tests (or have a good reason not to test in description ☝️)
  • Added changelog entry in both changelog.txt and readme.txt (or does not apply)
  • Tested on mobile (or does not apply)

Post merge

cc @diegocurbelo

@wjrosa wjrosa self-assigned this Oct 23, 2024
@wjrosa wjrosa marked this pull request as ready for review October 23, 2024 15:45
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.

1 participant