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

chore: create script for updating RELEASE.md before PR #148

Closed
ayoayco opened this issue Oct 25, 2022 · 2 comments · Fixed by #232
Closed

chore: create script for updating RELEASE.md before PR #148

ayoayco opened this issue Oct 25, 2022 · 2 comments · Fixed by #232
Assignees

Comments

@ayoayco
Copy link
Member

ayoayco commented Oct 25, 2022

✨ Desired outcome: easily update correct RELEASE.md file for a change that a PR will bring

Running the script should be able to

  1. ask for scope and type of change the PR will bring in
  2. correctly identify the appropriate RELEASE.md file
  3. ask for message
  4. write message to appropriate section of the file (fix or feat)

The script could later be used for automating update of change logs depending on PR title :)

@NeilAn99
Copy link
Contributor

Hey, I would be interested in this, but I have a couple questions.

  1. Should the script be run by the user before they create a PR? Something like npm run release and then they enter in the details?
  2. Where should the RELEASE.md file and the script file be located?

@ayoayco
Copy link
Member Author

ayoayco commented Nov 30, 2022

  1. Should the script be run by the user before they create a PR? Something like npm run release and then they enter in the details?

Yes, the contributor will run it before a PR. One of the questions will be which package was affected: form / validator.

  1. Where should the RELEASE.md file and the script file be located?

Depending on the package selected, you will find a RELEASE.md file (eg, packages/form/RELEASE.md for the form package)

Also think of the scenario where PRs affect multiple packages. Should the contributor re-run the script or can you have a prompt like how many packages are affected? or do you want to update another package release?

@NeilAn99

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

Successfully merging a pull request may close this issue.

2 participants