Skip to content

Commit

Permalink
📝 Add links for GitLab job examples
Browse files Browse the repository at this point in the history
  • Loading branch information
veit committed Sep 3, 2024
1 parent 4e497ad commit 4aac510
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
21 changes: 13 additions & 8 deletions docs/productive/git/advanced/gitlab/ci-cd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Continuous Delivery
<deployment-branches>`.

.. seealso::
* `Continuous Delivery <https://continuousdelivery.com>`_
* `Continuous Delivery
* `continuousdelivery.com <https://continuousdelivery.com>`_
* `Wikipedia: Continuous Delivery
<https://en.wikipedia.org/wiki/Continuous_delivery>`__

Continuous Deployment
Expand Down Expand Up @@ -65,14 +65,19 @@ Jobs
define what needs to be done, for example compiling code or testing.

.. seealso::
`Jobs <https://docs.gitlab.com/ee/ci/jobs/index.html>`_
* `GitLab Docs: Jobs
<https://docs.gitlab.com/ee/ci/jobs/index.html>`_
* :ref:`cibuildwheel <python-basics:cibuildwheel-in-gitlab-ci>`
* :ref:`pre-commit Hooks <pre-commit-in-gitlab-ci>`
* :ref:`Licensing <reuse-in-gitlab-ci>`

Stages
define when the jobs are to be executed, for example the phase ``test`` to
be executed after the phase ``build``.

.. seealso::
`Stages <https://docs.gitlab.com/ee/ci/yaml/index.html#stages>`_
`GitLab Docs: CI/CD YAML syntax reference
<https://docs.gitlab.com/ee/ci/yaml/index.html#stages>`_

*Jobs* are executed by so-called `runners
<https://docs.gitlab.com/ee/ci/runners/index.html>`_. Several *jobs* in a
Expand Down Expand Up @@ -157,11 +162,11 @@ a running pipeline, retry *jobs* in a failed pipeline or delete a pipeline.
GitLab CI/CD pipeline

.. seealso::
* `Customize pipeline configuration
* `GitLab Docs: Customize pipeline configuration
<https://docs.gitlab.com/ee/ci/yaml/index.html>`_
* `Scheduled pipelines
* `GitLab Docs: Scheduled pipelines
<https://docs.gitlab.com/ee/ci/pipelines/schedules.html>`_
* `GitLab CI/CD variables
* `GitLab Docs: GitLab CI/CD variables
<https://docs.gitlab.com/ee/ci/variables/index.html>`_
* `Predefined variables reference
* `GitLab Docs: Predefined variables reference
<https://docs.gitlab.com/ee/ci/variables/predefined_variables.html>`_
2 changes: 1 addition & 1 deletion docs/productive/git/advanced/gitlab/merge-requests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Merge request workflows
<https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html>`_ in
:doc:`GitLab CI/CD <ci-cd>`.
#. You avoid using dependencies whose licence is incompatible with your project
with :ref:`licence compliance reports <gitlab-ci-workflow>`.
with :ref:`licence compliance reports <reuse-in-gitlab-ci>`.
#. You request `approval
<https://docs.gitlab.com/ee/user/project/merge_requests/approvals/index.html>`_
of your changes.
Expand Down
2 changes: 2 additions & 0 deletions docs/productive/git/advanced/hooks/ci.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Examples for GitHub Actions

* `pre-commit/action <https://github.com/pre-commit/action>`_

.. _pre-commit-in-gitlab-ci:

Example for GitLab Actions
--------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/productive/licensing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ dynamic compliance badge:
.. figure:: reuse-compliant.svg
:alt: REUSE-compliant Badge

.. _gitlab-ci-workflow:
.. _reuse-in-gitlab-ci:

CI workflow
:::::::::::
Expand Down

0 comments on commit 4aac510

Please sign in to comment.