doc.go RawHistoryFolder

1// SPDX-License-Identifier: MIT
2
3// Package action reads GitHub Actions action.yml manifests the way GitHub
4// does: the model it returns is what the runner's ActionManifestManager gets
5// out of the same file, with the same errors.
6//
7// [Parse] follows the C# runner (actions/runner, Runner.Worker/
8// ActionManifestManagerLegacy.cs, which is what ActionManifestManagerWrapper
9// runs; the newer ActionManifestManager only runs next to it, behind a
10// comparison flag, and its result is thrown away). The runner reads the file
11// with its own schema, action_yaml.json, which is the "action-root" definition
12// of the schema that this package vendors, action-v1.0.json of the npm package
13// @actions/workflow-parser 0.3.61 (MIT, GitHub, actions/languageservices): that
14// definition accepts unknown top-level keys (icon, color, branding...), needs
15// no name and no description, and checks the keys under "runs" and the
16// contexts that expressions may use. [ParseStrict] reads the file against the
17// same schema's "action-root-strict" definition instead, which is the language
18// service's linter: name, description and runs are required, branding and
19// "using" are checked and unknown top-level keys are refused. GitHub accepts
20// files that the strict form refuses; use it to lint, not to run.
21//
22// The steps of a composite action are [workflow.Step] values, converted the way
23// the runner converts them (which is not the way package workflow converts the
24// steps of a workflow file). Expressions stay unevaluated [template.Token]
25// values; package template evaluates them.
26//
27// Errors read like the runner's: positioned messages ("action.yml (Line: 3,
28// Col: 5): Unexpected value 'x'") and, after them, the exceptions that the
29// runner reports with their .NET class name ("System.ArgumentNullException:
30// ..."). The runner prints exception stack traces after them; those are not
31// reproduced. PORTING.md lists what differs from the runner and from the
32// language service, and what was checked against which source.
33package action