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

Custom Pull Request body #65

Open
chaitanyadeorukhkar opened this issue Jan 8, 2021 · 4 comments
Open

Custom Pull Request body #65

chaitanyadeorukhkar opened this issue Jan 8, 2021 · 4 comments

Comments

@chaitanyadeorukhkar
Copy link

Right now, the PR body is either

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to master, this PR will be updated.

or

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or setup this action to publish automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to master, this PR will be updated.

I was wondering if we can accept a prBody via VersionOptions like we accept prTitle. I wanted to understand if there was any specific reason, this customization was restricted to title only. I'd be happy to raise a PR with these changes if the maintainers think this would be a good addition.

@Andarist
Copy link
Member

Andarist commented Jan 8, 2021

Question is - how would you like to customize it?

@chaitanyadeorukhkar
Copy link
Author

I should have explained my use-case 😄

We are using this for projects that are not npm-publishable packages (web & mobile apps). We really like the philosophy and process of creating changesets and want to use it without the need to publish it at the end. This is why I'd like to skip having the explanation of publishing in the PR body that might confuse someone who looks at the version update PR.

My version update PR could have a body like this

This is an automated version update PR 🚀
Merge this whenever you are ready to cut a release for the app. New changes made to the master branch will continue to get added in the changelog included in this PR.

Followed by the changelog of single/multiple packages.

@Andarist
Copy link
Member

Hmm, I understand that the context of your project is a little bit different but even the PR body that you have given mentions something being published. Is this that big a problem that a publish process looks a little bit different than the one for npm? It's still there and I wouldn't think that the existing message would confuse anyone. Don't take me wrong - I'm not super opposed to allowing to configure it (although it would complicate a bunch of stuff), just bike-shedding a little bit before taking a final decision.

@alex-page
Copy link

alex-page commented May 30, 2022

@Andarist our team would love to add a checklist to the pull request before folks hit merge. To make sure that thorough testing has happened. Is this something that would want to warrant this change?

Is the complication due to the release content reading from the merged PR content? Could this be decoupled into prefix instead of body and then removed from the release documentation?

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

🛑 Before shipping

  • I have tested this NPM package in our documentation website
  • I have tested this NPM package in our product
  • ...

Releases

@shopify/[email protected]

Minor Changes

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

No branches or pull requests

3 participants