Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial proposal for pipeline stage terminology #76

Merged
merged 11 commits into from
Apr 22, 2022
Merged

Initial proposal for pipeline stage terminology #76

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9a75dfc
initial proposal for build stage terminology
amfred Dec 17, 2021
d79727d
re-format and respond to first round of comments
amfred Dec 20, 2021
2ab5e63
edits suggested by review comments, tweaked software terms
amfred Dec 22, 2021
bc6dad4
response to comments, fixed toc
amfred Jan 10, 2022
d9549c0
Merge branch 'master' into build-stage-proposal
amfred Jan 10, 2022
230f420
Merge branch 'master' into build-stage-proposal
amfred Jan 10, 2022
e6a4207
merge toc
amfred Jan 10, 2022
49e0551
Merge branch 'master' into build-stage-proposal
amfred Mar 6, 2022
7508276
reponses to comments
amfred Mar 6, 2022
97a29dc
Merge branch 'build-stage-proposal' of github.com:amfred/sig-interope…
amfred Mar 6, 2022
6814130
reponses to comments
amfred Mar 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/vocabulary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,18 @@ pipeline in corresponding documentation.
| **Tekton** | N/A | Step | Task | Pipeline | Trigger | Resource (?) |
| **Zuul** | N/A | N/A | Job | Pipeline | Trigger | Node (?) |

### Build Stages

The table below is an attempt to create a mapping of common names for build stages (the unit of work one degree smaller than a pipeline). While CI/CD Tools and Technologies generally give developers broad leeway in naming and implementing their build stages, agreeing upon some common terms will help develop more pluggable build pipelines.
amfred marked this conversation as resolved.
Show resolved Hide resolved

| Stage | Semantics | Aliases | Inputs | Outputs and Results |
|------------|---------------|---------------|----------|-----------------------|
| **Build** | Set up the build workspace and provision build resources. Download, retrieve, assemble, and/or compile software into an executable and testable format. Download, retrieve, assemble, and/or compile documentation into a consumable format. | N/A | Source Code, Other Software Artifacts, Documentation | Executable Software, Compiled Documentation |
amfred marked this conversation as resolved.
Show resolved Hide resolved
| **Test** | Test, scan, verify, and lint software and documentation. | Verify | Executable Software, Compiled Documentation | Test/Lint/Scan Results, Test/Lint/Scan Reports, Test/Lint/Scan Coverage Reports |
| **Release** | Package, version, sign, and publish software artifacts and documentation. | Publish | Software Artifacts, Documentation | Release Reports, Software Artifacts and Documentation: packaged, signed, and published to a repository. |
amfred marked this conversation as resolved.
Show resolved Hide resolved
| **Deploy** | Deploy software artificats and documentation to any environment other than the build environment. Verify successful deployment. | N/A | Software Artifacts, Documentation | Software running in another environment. Documentation hosted in another environment. |
amfred marked this conversation as resolved.
Show resolved Hide resolved
| **Maintain** | Automatically update or upgrade previously built software. May include some or all of the previous stages. | Update, Upgrade | See Above | See Above |

### SCM Tools and Technologies

The table below is an attempt to create a mapping of different terms used
Expand Down