diff --git a/docs/docs/20-usage/15-terminology.md b/docs/docs/20-usage/15-terminology.md new file mode 100644 index 000000000..f27446b5c --- /dev/null +++ b/docs/docs/20-usage/15-terminology.md @@ -0,0 +1,42 @@ +# Terminology + +## Glossary + +- **Woodpecker CI**: The project name around Woodpecker. +- **Woodpecker**: An open-source tool that executes [pipelines][Pipeline] on your code. +- **Server**: The component of Woodpecker that handles webhooks from forges, orchestrates agents, and sends status back. It also serves the API and web UI for administration and configuration. +- **Agent**: A component of Woodpecker that executes [pipelines][Pipeline] (specifically one or more [workflows][Workflow]) with a specific backend (e.g. [Docker][], Kubernetes, [local][Local]). It connects to the server via GRPC. +- **CLI**: The Woodpecker command-line interface (CLI) is a terminal tool used to administer the server, to execute pipelines locally for debugging / testing purposes, and to perform tasks like linting pipelines. +- **Pipeline**: A sequence of [workflows][Workflow] that are executed on the code. [Pipelines][Pipeline] are triggered by events. +- **Workflow**: A sequence of steps and services that are executed as part of a [pipeline][Pipeline]. Workflows are represented by YAML files. Each [workflow][Workflow] has its own isolated [workspace][Workspace], and often additional resources like a shared network (docker). +- **Steps**: Individual commands, actions or tasks within a [workflow][Workflow]. +- **Code**: Refers to the files tracked by the version control system used by the [forge][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 folder shared between all steps of a [workflow][Workflow] containing the repository and all the generated data from previous steps. +- **Event**: Triggers the execution of a [pipeline][Pipeline], such as a [forge][Forge] event like `push`, or `manual` triggered manually from the UI. +- **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][Workflow] for each value in the [matrix][Matrix]. +- **Service**: A service is a step that is executed from the start of a [workflow][Workflow] until its end. It can be accessed by name via the network from other steps within the same [workflow][Workflow]. +- **Plugins**: [Plugins][Plugin] are extensions that provide pre-defined actions or commands for a step in a [workflow][Workflow]. They can be configured via settings. +- **Container**: A lightweight and isolated environment where commands are executed. +- **YAML File**: A file format used to define and configure [workflows][Workflow]. +- **Dependency**: [Workflows][Workflow] can depend on each other, and if possible, they are executed in parallel. +- **Status**: Status refers to the outcome of a step or [workflow][Workflow] after it has been executed, determined by the internal command exit code. At the end of a [workflow][Workflow], its status is sent to the [forge][Forge]. + +## Terms + +Sometimes there exist multiple terms that can be used for a thing, we try to define it here once and stick to it. + +- environment variables `*_LINK` should be `*_URL`, also in code, use `URL()` instead of `Link` ([Vote](https://framadate.org/jVSQHwIGfJYy82IL)) +- **Pipelines** were previously called **builds** +- **Steps** were previously called **jobs** + +[Pipeline]: ./20-pipeline-syntax.md +[Workflow]: ./25-workflows.md +[Forge]: ../30-administration/11-forges/10-overview.md +[Plugin]: ./51-plugins/10-plugins.md +[Workspace]: ./20-pipeline-syntax.md#workspace +[Matrix]: ./30-matrix-pipelines.md +[Docker]: ../30-administration/22-backends/10-docker.md +[Local]: ../30-administration/22-backends/20-local.md diff --git a/docs/docs/92-development/09-terms.md b/docs/docs/92-development/09-terms.md deleted file mode 100644 index 7b9479687..000000000 --- a/docs/docs/92-development/09-terms.md +++ /dev/null @@ -1,5 +0,0 @@ -# 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)] diff --git a/server/forge/mocks/forge.go b/server/forge/mocks/forge.go index 0acae699d..ecb9cc961 100644 --- a/server/forge/mocks/forge.go +++ b/server/forge/mocks/forge.go @@ -1,4 +1,4 @@ -// Code generated by mockery v2.28.1. DO NOT EDIT. +// Code generated by mockery v2.28.2. DO NOT EDIT. package mocks diff --git a/server/store/mocks/store.go b/server/store/mocks/store.go index effaea107..20d09eede 100644 --- a/server/store/mocks/store.go +++ b/server/store/mocks/store.go @@ -1,4 +1,4 @@ -// Code generated by mockery v2.28.1. DO NOT EDIT. +// Code generated by mockery v2.28.2. DO NOT EDIT. package mocks