[WIP] Adds github action for creating batch release #10298
Conversation
github-actions
bot
added
p: go_router
triage-framework
chunhtai
added
override: no versioning needed
|
reason for override: ci only change |
| - name: Set up tools | ||
| run: dart pub get | ||
| working-directory: ${{ github.workspace }}/script/tool | ||
| # Give some time for LUCI checks to start becoming populated. |
There was a problem hiding this comment.
Why is this needed in the context of this action?
There was a problem hiding this comment.
This is copied from release.yaml. Do you want me to factor the set up tools github action to a separate one? so that we don't duplicate code in a bunch of place
| create_release_pr: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| BRANCH_NAME: ${{ github.event.client_payload.package }}-${{ github.run_id }}-${{ github.run_attempt }} |
There was a problem hiding this comment.
So the cron job is constantly creating new branches? What cleans up branches that don't actually end up published?
There was a problem hiding this comment.
I see that can be a problem. then I think the right thing to do will be re-use the same branch name and do a clean up before creating a new release
There was a problem hiding this comment.
If these files are going to be created as part of the PR process, then the tooling should be updated to understand that, and the override labels shouldn't be needed on this PR. If the PR isn't landable without overrides, then the normal commit path isn't working correctly.
There was a problem hiding this comment.
yes, that part of the work will be in flutter/flutter#176433.
|
|
||
| print(' Pushing to remote...'); | ||
| final io.ProcessResult pushResult = | ||
| await repository.runCommand(<String>['push', 'origin', branchName, '--force']); |
There was a problem hiding this comment.
Here too, --force seems needlessly dangerous. I don't see why we would need to enable this command to be destructive.
| throw FormatException('Expected "changelog" to be a list, but found ${changelogYaml.runtimeType}.'); | ||
| } | ||
| final List<String> changelog = changelogYaml.nodes | ||
| .map((YamlNode node) => node.value as String) |
There was a problem hiding this comment.
What happened to allowing arbitrary markdown? How would someone make this changelog for instance?
There was a problem hiding this comment.
we can use | for arbitrary markdown in yaml will need to check whether dart yaml support this properly. now I think of it maybe the changelog part of the yaml shouldn't be a list, it should just be a single element that accept arbitrary markdown.
version: major
changelogs: |
my *markdown*
- item **one**
- item two
2 participants
fixes flutter/flutter#176425
To set up a batch release cron job for a package, one needs to make a copy of packages/.github/workflows/go_router_batch.yml, and change the name and cron schedule.
The cron job does the follow:
batch_release_pr:
Pre-Review Checklist
[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under1.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under1.///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2 ↩3