mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-15 15:30:26 +00:00
5f757d9e83
Partial backport of #9434. Fixes a bug: it was intended that pushes to a branch and pushes to a pull request would cancel any previous running job from the same workflow, however this functionality only worked on a `on: push` workflow. This PR fixes it for an `on: pull_request` workflow. Adds a feature: `concurrency.cancel-in-progress` can be used to override the automatic cancellation behaviour and disable it. It can be disabled unconditionally in a workflow: ```yaml concurrency: cancel-in-progress: false ``` Or it can be disabled with some logic; for example, keeping the cancel behaviour on PRs but disabling it otherwise: ```yaml concurrency: cancel-in-progress: ${{ github.event_name == 'pull_request' }} ``` Only a small subset of automated tests were applicable for backport, so I supplemented with manual testing in these cases: | | Expected | Actual | | ------------------------------------------------------------------ | ------------- | ------------- | | Default behaviour: | | | | on: pull_request -- push to a PR when it's already running | Cancelled | Cancelled | | on: push -- push to a branch (eg. main) when it's already running | Cancelled | Cancelled | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | | | | | | Set cancel-in-progress: true | | | | on: pull_request -- push to a PR when it's already running | Cancelled | Cancelled | | on: push -- push to a branch (eg. main) when it's already running | Cancelled | Cancelled | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | | | | | | Set cancel-in-progress: false | | | | on: pull_request -- push to a PR when it's already running | Multiple Runs | Multiple Runs | | on: push -- push to a branch (eg. main) when it's already running | Multiple Runs | Multiple Runs | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | | | | | | Set cancel-in-progress: ${{ github.event_name == 'pull_request' }} | | | | on: pull_request -- push to a PR when it's already running | Cancelled | Cancelled | | on: push -- push to a branch (eg. main) when it's already running | Multiple Runs | Multiple Runs | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - **TODO:** Will backport the relevant documentation. - [ ] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/9797): <!--number 9797 --><!--line 0 --><!--description ZmVhdDogYWxsb3cgd29ya2Zsb3dzIHRvIGNvbnRyb2wgY2FuY2VsbGF0aW9uIG9mIGV4aXN0aW5nIGpvYnM=-->feat: allow workflows to control cancellation of existing jobs<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9797 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Reviewed-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net> |
||
|---|---|---|
| .. | ||
| TestServiceActions_startTask | ||
| auth.go | ||
| auth_test.go | ||
| cleanup.go | ||
| cleanup_test.go | ||
| clear_tasks.go | ||
| commit_status.go | ||
| context.go | ||
| context_test.go | ||
| init.go | ||
| interface.go | ||
| job_emitter.go | ||
| job_emitter_test.go | ||
| job_parser.go | ||
| job_parser_test.go | ||
| main_test.go | ||
| notifier.go | ||
| notifier_helper.go | ||
| notifier_helper_test.go | ||
| rerun.go | ||
| rerun_test.go | ||
| schedule_tasks.go | ||
| schedule_tasks_test.go | ||
| task.go | ||
| variables.go | ||
| variables_test.go | ||
| workflows.go | ||
| workflows_test.go | ||