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

Recommended way to Update additional files within a release. #2022

Closed
aaronware opened this issue Jul 20, 2023 · 3 comments
Closed

Recommended way to Update additional files within a release. #2022

aaronware opened this issue Jul 20, 2023 · 3 comments
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: question Request for information or clarification. Not an issue.

Comments

@aaronware
Copy link

This is potentially an extension of #1798 that I reported in January. We have some additional files that we want to edit related to a given release. Were not looking to update versions but more so looking to update arbitrary information within comment blocks.

A few real-world examples for us beyond #1798. When a release is happening we update about 7-10 files with version number bumps however for our projects we have dependencies that we also like to list in the release and the versions of each of those dependencies typically within various readme files. Since our projects primarily are WordPress based; those dependencies could be composer, npm, or even a list of WordPress plugins associated with the project.

These types of files changes are not something the core of release-please should really need to worry about so I was wondering if there was a specific hook/event or ability to create custom updaters or have them included without making a pull request on top of a pull request? Mainly we want to be able to define our list of files in the release-please-config.js and a path to a custom updater that could run through and update accordingly (probably based on other clearly defined comment blocks.

Not really sure about the security implications or the complexity or if this approach makes sense

If there is a "better" approach to accomplish what I am trying, or if I should hit up the release-please-action project I can do that as well.

@aaronware aaronware added priority: p3 Desirable enhancement or fix. May not be included in next release. type: question Request for information or clarification. Not an issue. labels Jul 20, 2023
@chingor13
Copy link
Contributor

My personal recommendation is to chain automations rather than trying to get release-please to do what you want here. You can configure release-please to add arbitrary labels to the PR it creates which you can use in other automations to identify a release PR. Other automations can potentially make changes in that branch and directly commit to that branch.

@aaronware
Copy link
Author

I don't necessarily disagree. I'll give it some experimentation. Thanks @chingor13

@danielo515
Copy link

Can someone detail that strategy a bit more? How do you add those attributes, and how do you read data from them?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: question Request for information or clarification. Not an issue.
Projects
None yet
Development

No branches or pull requests

3 participants