mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-03-26 12:13:07 -04:00
75cb38faa6
This change allows the `with:` field of a reusable workflow to reference a previous job, such as `with: { some-input: "${{ needs.other-job.outputs.other-output }}" }`. `strategy.matrix` can also reference `${{ needs... }}`.
When a job is parsed and encounters this situation, the outer job of the workflow is marked with a field `incomplete_with` (or `incomplete_matrix`), indicating to Forgejo that it can't be executed as-is and the other jobs in its `needs` list need to be completed first. And then in `job_emitter.go` when one job is completed, it checks if other jobs had a `needs` reference to it and unblocks those jobs -- but if they're marked with `incomplete_with` then they can be sent back through the job parser, with the now-available job outputs, to be expanded into the correct definition of the job.
The core functionality for this already exists to allow `runs-on` and `strategy.matrix` to reference the outputs of other jobs, but it is expanded upon here to include `with` for reusable workflows.
There is one known defect in this implementation, but it has a limited scope -- if this code path is used to expand a nested reusable workflow, then the `${{ input.... }}` context will be incorrect. This will require an update to the jobparser in runner version 12.4.0, and so it is out-of-scope of this PR.
## 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)).
- **end-to-end test:** will require the noted "known defect" to be resolved, but tests are authored at https://code.forgejo.org/forgejo/end-to-end/compare/main...mfenniak:expand-reusable-workflows-needs
### Documentation
- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [x] 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.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10647
Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
74 lines
3.6 KiB
Go
74 lines
3.6 KiB
Go
// Copyright 2025 The Forgejo Authors. All rights reserved.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
package actions
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"forgejo.org/modules/translation"
|
|
)
|
|
|
|
type PreExecutionError int64
|
|
|
|
// PreExecutionError values are stored in the database in ActionRun.PreExecutionError and therefore values can't be
|
|
// reordered or changed without a database migration. Translation arguments are stored in the database in
|
|
// PreExecutionErrorDetails, and so they can't be changed or reordered without creating a migration or a new error code
|
|
// to represent the new argument details.
|
|
const (
|
|
ErrorCodeEventDetectionError PreExecutionError = iota + 1
|
|
ErrorCodeJobParsingError
|
|
ErrorCodePersistentIncompleteMatrix // obsolete
|
|
ErrorCodeIncompleteMatrixMissingJob
|
|
ErrorCodeIncompleteMatrixMissingOutput
|
|
ErrorCodeIncompleteMatrixUnknownCause
|
|
ErrorCodeIncompleteRunsOnMissingJob
|
|
ErrorCodeIncompleteRunsOnMissingOutput
|
|
ErrorCodeIncompleteRunsOnMissingMatrixDimension
|
|
ErrorCodeIncompleteRunsOnUnknownCause
|
|
ErrorCodeIncompleteWithMissingJob
|
|
ErrorCodeIncompleteWithMissingOutput
|
|
ErrorCodeIncompleteWithMissingMatrixDimension
|
|
ErrorCodeIncompleteWithUnknownCause
|
|
)
|
|
|
|
func TranslatePreExecutionError(lang translation.Locale, run *ActionRun) string {
|
|
if run.PreExecutionError != "" {
|
|
// legacy: Forgejo v13 stored value pre-translated, preventing correct translation to active user
|
|
return run.PreExecutionError
|
|
}
|
|
|
|
switch run.PreExecutionErrorCode {
|
|
case 0:
|
|
return ""
|
|
case ErrorCodeEventDetectionError:
|
|
return lang.TrString("actions.workflow.event_detection_error", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeJobParsingError:
|
|
return lang.TrString("actions.workflow.job_parsing_error", run.PreExecutionErrorDetails...)
|
|
case ErrorCodePersistentIncompleteMatrix:
|
|
return lang.TrString("actions.workflow.persistent_incomplete_matrix", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteMatrixMissingJob:
|
|
return lang.TrString("actions.workflow.incomplete_matrix_missing_job", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteMatrixMissingOutput:
|
|
return lang.TrString("actions.workflow.incomplete_matrix_missing_output", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteMatrixUnknownCause:
|
|
return lang.TrString("actions.workflow.incomplete_matrix_unknown_cause", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteRunsOnMissingJob:
|
|
return lang.TrString("actions.workflow.incomplete_runson_missing_job", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteRunsOnMissingOutput:
|
|
return lang.TrString("actions.workflow.incomplete_runson_missing_output", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteRunsOnMissingMatrixDimension:
|
|
return lang.TrString("actions.workflow.incomplete_runson_missing_matrix_dimension", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteRunsOnUnknownCause:
|
|
return lang.TrString("actions.workflow.incomplete_runson_unknown_cause", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteWithMissingJob:
|
|
return lang.TrString("actions.workflow.incomplete_with_missing_job", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteWithMissingOutput:
|
|
return lang.TrString("actions.workflow.incomplete_with_missing_output", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteWithMissingMatrixDimension:
|
|
return lang.TrString("actions.workflow.incomplete_with_missing_matrix_dimension", run.PreExecutionErrorDetails...)
|
|
case ErrorCodeIncompleteWithUnknownCause:
|
|
return lang.TrString("actions.workflow.incomplete_with_unknown_cause", run.PreExecutionErrorDetails...)
|
|
}
|
|
return fmt.Sprintf("<unsupported error: code=%v details=%#v", run.PreExecutionErrorCode, run.PreExecutionErrorDetails)
|
|
}
|