Modify sync-pr to be triggered on Solidity release #53
Conversation
r0qs
force-pushed
the
sync-pr-bot-on-release
branch
from
b866587 to
c7c31e7
Compare
r0qs
changed the title
| @@ -36,7 +58,7 @@ jobs: | |||
| - zh-chinese | |||
| steps: | |||
| - name: Fetch translation repository | |||
| uses: actions/checkout@v2 | |||
| uses: actions/checkout@v4 | |||
There was a problem hiding this comment.
Does the PR depend on this? It seems like it's an independent change so it should be at least a separate commit. Or even a separate PR.
| @@ -127,3 +149,25 @@ jobs: | |||
| labels: "${{ join(fromJSON(steps.bot-config.outputs.pr_labels)) }}" | |||
| assignees: ${{ env.assignee }} | |||
| reviewers: ${{ env.reviewer }} | |||
|
|
|||
| - name: Fetch Solidity translation repository | |||
| uses: actions/checkout@v4 | |||
There was a problem hiding this comment.
This will fetch bot's repository, not the translation's repository.
| createPullRequest: | ||
| runs-on: ubuntu-latest | ||
| needs: checkSolidityRelease | ||
| if: needs.checkSolidityRelease.outputs.current_release != needs.checkSolidityRelease.outputs.latest_release |
There was a problem hiding this comment.
This is not quite what I meant in #22. This will still create a daily sync PR, just at some arbitrary moment after the release. That's because pull-and-resolve-english-changes.sh will still pull code from develop and not the tag so it may have some extra commits.
Doing it properly, on the tag, isn't even really harder if you're replacing the daily sync PRs (rather than keeping support for both).
| createPullRequest: | ||
| runs-on: ubuntu-latest | ||
| needs: checkSolidityRelease | ||
| if: needs.checkSolidityRelease.outputs.current_release != needs.checkSolidityRelease.outputs.latest_release |
There was a problem hiding this comment.
Another problem is that it can only create a PR for the latest release. We should really create a PR for the first untagged release in the repo and only when there's no other pending release sync PR (we can make that no pending sync PR in general for simplicity). So that translators can translate one version at a time. We could fall back to latest if the translation repo has no version tags though.
Doing it this way would actually be simpler, because you'd not need this whole stateful setup with keeping a version file in the repo and having to create PRs to update it - which will just result in more maintenance effort for us.
There was a problem hiding this comment.
The sync PR description also says that it's perfectly safe to close a sync PR and wait for the next one and with this change it's no longer true, which will create problems for translators.
The description of the sync PR should also be updated to say that sync PRs are generated when there's an untranslated release and no pending sync PR (rather than in regular intervals as until now) so that they know when to expect one.
This PR modifies the behavior of the sync-pr bot. While the workflow still triggers daily to monitor the latest Solidity release, it will now only initiate sync-prs if a new release is detected. The new job compares the latest tagged release with the current release stored in this repository (initially set to
0.8.24). If they differ, it will then trigger thecreatePullRequestjob to generate the sync PRs on the translation repositories and create another PR to this repo to update the current version to the latest release.Fixes #22