parse.go RawHistoryFolder

1// SPDX-License-Identifier: MIT
2
3package workflow
4
5import (
6	"bnema.dev/ermite-actions/template"
7)
8
9// rootType is the schema definition a workflow file is read against; its
10// "on" key is required.
11const rootType = "workflow-root-strict"
12
13// Parse reads, validates and converts a workflow file. path is only used in
14// error messages, which read "path (Line: l, Col: c): message".
15//
16// The errors are the reference's: syntax errors, schema violations, unknown
17// contexts and functions in expressions, and the checks of the converter (job
18// and step ids, needs, filters, inputs). When there is any error the workflow
19// is nil. As in the reference, the converter only runs when the file passes
20// the schema. One check is not the reference's: an event that uses both a
21// filter and its "-ignore" counterpart (branches and branches-ignore, tags and
22// tags-ignore, paths and paths-ignore) is an error, as on GitHub.
23func Parse(path string, content []byte) (*Workflow, []Error) {
24	schema, err := template.WorkflowSchema()
25	if err != nil {
26		return nil, []Error{{Raw: "internal error: " + err.Error()}}
27	}
28	ctx := template.NewContext(schema)
29	root := template.ReadYAML(ctx, rootType, path, content)
30	w := &Workflow{File: path}
31	if root != nil && !ctx.HasErrors() {
32		c := &converter{ctx: ctx, schema: schema, w: w, jobIDs: newIDBuilder()}
33		c.convertRoot(root)
34		c.validateFilters()
35	}
36	errs := collect(ctx)
37	if len(errs) > 0 {
38		return nil, errs
39	}
40	return w, nil
41}
42
43func collect(ctx *template.Context) []Error {
44	var out []Error
45	for _, e := range ctx.Errors() {
46		out = append(out, *e)
47	}
48	return out
49}