tangled.org
I've updated the documentation to list and explain all the fields that can be used in a workflow file. Some of the fields I had to look at the source code for, and I've done my best to document them, but I'm not very familiar with the codebase so I might have misunderstood some things.
+2
-14
docs/spindle/pipeline.md
+2
-14
docs/spindle/pipeline.md
···
1
-
# Spindle pipelines
1
+
# spindle pipelines
2
2
3
3
Spindle workflows allow you to write CI/CD pipelines in a simple format. They're located in the `.tangled/workflows` directory at the root of your repository, and are defined using YAML.
4
4
···
116
116
NODE_ENV: "production"
117
117
```
118
118
119
-
## Conclusion
120
-
121
-
The most minimal workflow, with only the required fields, looks like this:
122
-
123
-
```yaml
124
-
# .tangled/workflows/example.yml
125
-
126
-
when: []
127
-
128
-
engine: "nixery"
129
-
```
130
-
131
-
Of course, that isn't very useful as it doesn't do anything, and never even runs. The (much more useful) workflow we've created using the examples above looks like this:
119
+
## Complete workflow
132
120
133
121
```yaml
134
122
# .tangled/workflows/build.yml
Submissions
pull request successfully merged
10 commits
expand
collapse
8897e67d
docs: Update Spindle piplines documentation
22deed05
docs: Use H2 instead of H3 for headings
92f170f8
docs: Update text in dependencies section to sound better
b5e0f2a8
docs: Fix wording in triggers section
ab9b193e
docs: Add example filenames in comments in conclusion section
4e2098b2
docs: Add link to Tangled build workflow as an example
ab02db92
docs: Add second branch name as example
1a80c68d
docs: Add docs for
pull_request trigger for branch
ab111a36
docs: Fix wording and formatting
d99dfdf9
docs: Re-word and add link to dependencies section
https://tangled.sh/@zerolimits.dev/core/blob/master/docs/spindle/pipeline.md
rendered version for reference to reviewers.