Skip to content

Commit

Permalink
Define Glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
6543 committed Jun 1, 2023
1 parent 71d7a46 commit 5c1d8d1
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
29 changes: 29 additions & 0 deletions docs/docs/92-development/09-terminology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Terminology

## Glossary

- **Woodpecker**: An open-source tool that executes pipelines on your code.
- **Pipeline**: A sequence of workflows that are executed on the code. Pipelines are triggered by events.
- **Workflow**: A sequence of steps and services that are executed as part of a pipeline. Workflows are represented by YAML files. Each workflow has its own isolated network.
- **Steps**: Individual commands, actions or tasks within a workflow.
- **Code**: Refers to the files tracked by the version control system used by the forge.
- **Repos**: Short for repositories, these are storage locations where code is stored.
- **Forge**: The hosting platform or service where the repositories are hosted.
- **Workspace**: A separate environment or area where a workflow is executed in isolation.
- **Event**: Triggers the execution of a pipeline, such as a forge event, manual interaction in the user interface, cron job, or command-line interface.
- **Commit**: A defined state of the code, usually associated with a version control system like Git.
- **Matrix**: A configuration option that allows the execution of workflows for each value in the matrix.
- **Service**: A service is a step that is executed from the start of a workflow until its end. It can be accessed by name via the network from other steps within the same workflow.
- **Plugins**: Plugins are extensions that provide pre-defined actions or commands for a step in a workflow. They can be configured via settings.
- **Container**: A lightweight and isolated environment where commands are executed in.
- **YAML File**: A file format used to define and configure workflows.
- **Dependency**: Workflows can depend on each other, and if possible, they are executed in parallel.
- **Status**: Status refers to the outcome of a step or workflow after it has been executed, determined by the internal command exit code.

## Terms

Sometimes there exist multiple terms that can be used for a thing, we try to define it here once and stick to it.

- env var `*_LINK` should be `*_URL` also in code, use `URL()` instead of `Link` [[Vote](https://framadate.org/jVSQHwIGfJYy82IL)]
- Builds are Pipelines
- In old code there were `Jobs` witch revere to `Steps`
5 changes: 0 additions & 5 deletions docs/docs/92-development/09-terms.md

This file was deleted.

0 comments on commit 5c1d8d1

Please sign in to comment.