Merge branch 'convert-cookiecutter' into 'main'

Convert cookiecutter

See merge request !8

.gitlab-ci.common.yml

-# Copyright (C) ASTRON (Netherlands Institute for Radio Astronomy)
-# SPDX-License-Identifier: Apache-2.0
-
-workflow:
-  rules:
-    # Don't create a pipeline if it's a commit pipeline on a branch and that branch has open merge requests
-    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
-      when: never
-    - when: always
-
-# Set to 1 to force a rebuild of the Docker image
-variables:
-  BUILD_DOCKER_IMAGE: "0"
-  APPLICATION_LAST_RELEASE: "0.0.0"
-
-stages:
-  - versioning
-  - prepare
-  - linting
-  - build
-  - test
-  - pages
-  - deploy
-
-# This step determines the SHA1 of the Docker file used. It's stored in
-# versions.env artifact. The environment variables are available for all steps
-# depending on this step.
-versioning:
-  stage: versioning
-  image: bitnami/git
-  script:
-    - echo BASE_IMAGE=${CI_REGISTRY_IMAGE}/base:$(git log -n 1 --pretty=format:%H -- ci/ubuntu_22_04-base) > versions.env
-    - cat versions.env
-  artifacts:
-    reports:
-      dotenv: versions.env
-
-# Builds the Docker image containing the dependencies of the application.
-# This image is cached, as long as the Dockerfile isn't modified new jobs reuse
-# this image.
-build-docker-ubuntu-22.04:
-  stage: prepare
-  needs: ["versioning"]
-  image: docker:latest
-  before_script:
-    - echo $CI_REGISTRY_PASSWORD | docker login -u $CI_REGISTRY_USER --password-stdin $CI_REGISTRY
-  script:
-    - |
-      if ! docker manifest inspect $BASE_IMAGE > /dev/null || [ "$BUILD_DOCKER_IMAGE" = "1" ]; then
-        docker build --tag $BASE_IMAGE -f ci/ubuntu_22_04-base .
-        docker push $BASE_IMAGE
-      fi

.gitlab-ci.yml

-# Copyright (C) ASTRON (Netherlands Institute for Radio Astronomy)
-# SPDX-License-Identifier: Apache-2.0
+include:
+- local: "{{cookiecutter.project_slug}}/.gitlab-ci.yml"
 
-include: .gitlab-ci.common.yml
+trigger_prepare:
+  stage: prepare
+  trigger:
+    strategy: depend
+    include: "{{cookiecutter.project_slug}}/.prepare.gitlab-ci.yml"
 
+default:
+  # Bootstrap Cookiecutter template to test provided ci pipeline template
+  before_script:
+    - cookiecutter --no-input --overwrite-if-exists --output-dir . .
+    - cd my_awesome_app
+    - git init
+
+sast:
+  # override before_script from default: definition above, inherited job image otherwise
+  # won't have Python available
+  before_script:
+    - python --version # For debugging
+
+dependency_scanning:
+  # override before_script from default: definition above, inherited job image otherwise
+  # won't have Python available
+  before_script:
+    - uname
+
+secret_detection:
+  # override before_script from default: definition above, inherited job image otherwise
+  # won't have Python available
+  before_script:
+    - uname
+
+# Override format artifact paths
 format:
-  stage: linting
-  needs: ["versioning", "build-docker-ubuntu-22.04"]
-  image: $BASE_IMAGE
-  script:
-    - scripts/format-cpp.sh
-    - scripts/format-cmake.sh
-    - git diff > format.patch
-    # Fail when the patch is not empy (note ! can't be used directly.)
-    - (! grep -q '^--- a'  format.patch)
   artifacts:
     when: on_failure
     paths:
-      - format.patch
-
-tidy:
-  stage: linting
-  needs: ["versioning", "build-docker-ubuntu-22.04"]
-  image: $BASE_IMAGE
-  script:
-    - mkdir build
-    - cd build
-    - cmake -DCMAKE_CXX_CLANG_TIDY=clang-tidy -G Ninja ..
-    - ninja
+      - my_awesome_app/format.patch
 
+# Override test artifact paths
 test:
-  stage: test
-  needs: ["versioning", "build-docker-ubuntu-22.04"]
-  image: $BASE_IMAGE
-  script:
-    - mkdir build
-    - cd build
-    - cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DCMAKE_CXX_FLAGS="-coverage" -DCMAKE_EXE_LINKER_FLAGS="-coverage" -G Ninja ..
-    - ninja
-    - ctest --output-on-failure |& tee ctest.out
-    - mkdir coverage
-    - gcovr -r .. -e ../test/ -e ../src/main.cpp --txt --xml coverage.xml --html-details coverage/coverage.html
-    - tar cfz coverage.tar.gz coverage/
   artifacts:
     paths:
       # This will give a warning which is ok
-      - build/test/unittests.xml
-      - build/coverage.tar.gz
+      - my_awesome_app/build/test/unittests.xml
+      - my_awesome_app/build/coverage.tar.gz
     reports:
-      junit: build/test/unittests.xml
+      junit: my_awesome_app/build/test/unittests.xml
       coverage_report:
         coverage_format: cobertura
-        path: build/coverage.xml
+        path: my_awesome_app/build/coverage.xml
 
-# See https://git.astron.nl/templates/cpp-project/-/wikis/ABI%20checker
+# Override abi-test artifact paths
 abi-test:
-  stage: test
-  needs: ["versioning", "build-docker-ubuntu-22.04"]
-  image: $BASE_IMAGE
-  script:
-    # The syntax is described at https://docs.gitlab.com/ee/user/packages/generic_packages/index.html
-    - 'curl --header  "JOB-TOKEN: $CI_JOB_TOKEN" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/ABI/${APPLICATION_LAST_RELEASE}/abi.dump" -o abi.dump'
-    - cmake --version
-    - mkdir build && cd build
-    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-Og -gdwarf-3" -GNinja ..
-    - ninja
-    - cd ..
-    - abi-dumper build/src/lib/libhello.so -o master.dump -lver master
-    # ABI failures are not only intended to be informative
-    - abi-compliance-checker -l hello -old abi.dump -new master.dump || true
   artifacts:
     paths:
-      - compat_reports/hello/${APPLICATION_LAST_RELEASE}_to_master
-
-build:
-  stage: build
-  needs: ["versioning", "build-docker-ubuntu-22.04"]
-  image: $BASE_IMAGE
-  script:
-    - mkdir build
-    - cd build
-    - cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ..
-    - ninja
+      - my_awesome_app/compat_reports/hello/${APPLICATION_LAST_RELEASE}_to_master
 
+# Override pages artifact paths
 pages:
-  stage: pages
-  needs: ["versioning", "test"]
-  image: $BASE_IMAGE
-  script:
-    # Generate documentation.
-    - cd build
-    - cmake -DBUILD_DOCUMENTATION=ON -G Ninja ..
-    - ninja sphinx
-    # Extract HTML coverage report.
-    - tar xfz coverage.tar.gz
-    # TODO: Add an index page with links to the documentation and coverage.
-
-abi-deplay:
-  stage: deploy
-  needs: ["versioning", "build-docker-ubuntu-22.04"]
-  image: $BASE_IMAGE
-  environment: production
-  script:
-    - cmake --version
-    - mkdir build && cd build
-    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-Og -gdwarf-3" -GNinja ..
-    - ninja
-    - cd ..
-    - abi-dumper build/src/lib/libhello.so -o ${APPLICATION_LAST_RELEASE}.dump -lver ${APPLICATION_LAST_RELEASE}
-    # The syntax is described at https://docs.gitlab.com/ee/user/packages/generic_packages/index.html
-    - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${APPLICATION_LAST_RELEASE}.dump "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/ABI/${APPLICATION_LAST_RELEASE}/abi.dump"'
-  rules:
-    -  when: manual
+  artifacts:
+    expire_in: 1w
+    paths:
+      - my_awesome_app/build/doc/*

README.md

-# C++ project
+# CPP Project CookieCutter Template
 
-An example repository of an CI/CD pipeline for building, testing and deploying a C++ project.
+![Build status](https://git.astron.nl/templates/cpp-project/badges/main/pipeline.svg)
+![Test coverage](https://git.astron.nl/templates/cpp-project/badges/main/coverage.svg)
 
-## Description
+An example repository of an CI/CD pipeline for building, testing and publishing a python package.
 
-The repository can be used as a basis for new projects using C++ within ASTRON.
-The code is intended to be copied in a new repository and used as basis for the
-new project. After copying the code needs to be adjusted for the specific
-project. The template offers:
+If you find some missing functionality with regards to CI/CD, testing, linting or something else, feel free to make a merge request with the proposed changes.
 
-- CI jobs for building, testing, and generating documentation
+## How to apply this template
 
-  - A basic Docker file to be used in the CI
-  - A CMake project skeleton
-  - A Doxygen and Sphinx skeleton for documentation
-  - Formatting scripts for the code
+This templates uses `cookiecutter` which can be easily installed:
 
-Note: The project is intended to be used for C++ projects without Fortran code.
-At the moment of writing there is no Fortran support for Ninja. This means the
-project needs to be changed to use `make`.
+```bash
+pip install --user cookiecutter
+```
 
-## Getting started
+Then you can create an instance of your template with:
 
-- Clone the project in the directory `$repo`
-- Install all dependencies as listed in `ci/ubuntu_22_04-base`
-- Create the project: `cmake -DBUILD_TESTING=ON -H$repo -B$repo/build -G Ninja`
-- Build the project: `ninja -C $repo/build`
-
-## Contributing
-
-To contribute, please create a feature branch and a "Draft" merge request. Upon
-completion, the merge request should be marked as ready and a reviewer should be
-assigned.
+```bash
+cookiecutter https://git.astron.nl/templates/cpp-project.git
+# Next follow a set of prompts (such as the name and description of the package)
+```
 
 ## License
-This project is licensed under the Apache License Version 2.0.
+This project is licensed under the Apache License Version 2.0

cookiecutter.json

+{
+    "project_name": "My Awesome App",
+    "project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_')|replace('.', '_')|trim() }}",
+    "project_url": "git.astron.nl/{{ cookiecutter.project_slug }}",
+    "description": "An example CPP project for CI/CD working group"
+}

docker/ci-runner/Dockerfile

+FROM ubuntu:22.04
+
+# This Docker image builds the dependencies for the application.
+# It lives on the head of its dependencies.
+
+# Install all build-time dependencies
+RUN export DEBIAN_FRONTEND=noninteractive && \
+	apt-get update && \
+	apt-get install -y \
+    abi-compliance-checker \
+    abi-dumper \
+    build-essential \
+    clang-format \
+    clang-tidy \
+    cmake \
+    cmake-format \
+    curl \
+    doxygen \
+    gcovr \
+    git \
+    graphviz \
+    libboost-test-dev \
+    ninja-build \
+    python3-breathe \
+    python3-pip && \
+	rm -rf /var/lib/apt/lists/*
+
+RUN python3 -m pip install --upgrade pip
+RUN pip install --upgrade cookiecutter tox twine --no-cache-dir
\ No newline at end of file

{{cookiecutter.project_slug}}/.gitlab-ci.yml

+# Copyright (C) ASTRON (Netherlands Institute for Radio Astronomy)
+# SPDX-License-Identifier: Apache-2.0
+
+default:
+  image: $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG
+
+workflow:
+  rules:
+    # Do not create (detached) pipelines on merge request events
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: never
+    - when: always
+
+stages:
+  - prepare
+  - linting
+  - test
+  - build
+  - integration
+  - publish # publish instead of deploy
+
+variables:
+  APPLICATION_LAST_RELEASE: "0.0.0"
+
+include:
+  - template: Security/SAST.gitlab-ci.yml
+  - template: Security/Dependency-Scanning.gitlab-ci.yml
+  - template: Security/Secret-Detection.gitlab-ci.yml
+
+# Prepare image to run ci on
+trigger_prepare:
+  stage: prepare
+  trigger:
+    strategy: depend
+    include: .prepare.gitlab-ci.yml
+
+format:
+  stage: linting
+  needs: ["trigger_prepare"]
+  script:
+    - scripts/format-cpp.sh
+    - scripts/format-cmake.sh
+    - git diff > format.patch
+      # Fail when the patch is not empy (note ! can't be used directly.)
+    - (! grep -q '^--- a'  format.patch)
+
+  artifacts:
+    when: on_failure
+    paths:
+      - format.patch
+
+tidy:
+  stage: linting
+  needs: ["trigger_prepare"]
+  script:
+    - mkdir build
+    - cd build
+    - cmake -DCMAKE_CXX_CLANG_TIDY=clang-tidy -G Ninja ..
+    - ninja
+
+sast:
+  variables:
+    SAST_EXCLUDED_ANALYZERS: brakeman, kubesec, nodejs-scan, phpcs-security-audit,
+      pmd-apex, sobelow, spotbugs
+  stage: test
+
+test:
+  stage: test
+  needs: ["trigger_prepare"]
+  script:
+    - mkdir build
+    - cd build
+    - cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DCMAKE_CXX_FLAGS="-coverage" -DCMAKE_EXE_LINKER_FLAGS="-coverage" -G Ninja ..
+    - ninja
+    - ctest --output-on-failure |& tee ctest.out
+    - mkdir coverage
+    - gcovr -r .. -e ../test/ -e ../src/main.cpp --txt --xml coverage.xml --html-details coverage/coverage.html
+    - tar cfz coverage.tar.gz coverage/
+  artifacts:
+    paths:
+      # This will give a warning which is ok
+      - build/test/unittests.xml
+      - build/coverage.tar.gz
+    reports:
+      junit: build/test/unittests.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: build/coverage.xml
+
+# See https://git.astron.nl/templates/cpp-project/-/wikis/ABI%20checker
+abi-test:
+  stage: test
+  needs: ["trigger_prepare"]
+  script:
+    # The syntax is described at https://docs.gitlab.com/ee/user/packages/generic_packages/index.html
+    - 'curl --header  "JOB-TOKEN: $CI_JOB_TOKEN" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/ABI/${APPLICATION_LAST_RELEASE}/abi.dump" -o abi.dump'
+    - cmake --version
+    - mkdir build && cd build
+    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-Og -gdwarf-3" -GNinja ..
+    - ninja
+    - cd ..
+    - abi-dumper build/src/lib/libhello.so -o master.dump -lver master
+    # ABI failures are not only intended to be informative
+    - abi-compliance-checker -l hello -old abi.dump -new master.dump || true
+  artifacts:
+    paths:
+      - compat_reports/hello/${APPLICATION_LAST_RELEASE}_to_master
+
+build:
+  stage: build
+  needs: ["trigger_prepare"]
+  script:
+    - mkdir build
+    - cd build
+    - cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ..
+    - ninja
+
+pages:
+  stage: build
+  needs: ["trigger_prepare"]
+  script:
+    # Generate documentation.
+    - mkdir build
+    - cd build
+    - cmake -DBUILD_DOCUMENTATION=ON -G Ninja ..
+    - ninja sphinx
+  artifacts:
+    expire_in: 1w
+    paths:
+      - build/doc/*
+
+abi-deploy:
+  stage: publish
+  needs: ["trigger_prepare"]
+  environment: production
+  script:
+    - cmake --version
+    - mkdir build && cd build
+    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-Og -gdwarf-3" -GNinja ..
+    - ninja
+    - cd ..
+    - abi-dumper build/src/lib/libhello.so -o ${APPLICATION_LAST_RELEASE}.dump -lver ${APPLICATION_LAST_RELEASE}
+    # The syntax is described at https://docs.gitlab.com/ee/user/packages/generic_packages/index.html
+    - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${APPLICATION_LAST_RELEASE}.dump "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/ABI/${APPLICATION_LAST_RELEASE}/abi.dump"'
+  rules:
+    -  when: manual

{{cookiecutter.project_slug}}/.prepare.gitlab-ci.yml

+stages:
+  - build
+
+build_ci_runner_image:
+  stage: build
+  image: docker:stable
+  services:
+    - docker:dind
+  script:
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - |
+      if docker pull $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG; then
+        docker build --cache-from $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG --tag $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG docker/ci-runner
+      else
+        docker pull $CI_REGISTRY_IMAGE/ci-build-runner:latest || true
+        docker build --cache-from $CI_REGISTRY_IMAGE/ci-build-runner:latest --tag $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG docker/ci-runner
+      fi
+    - docker push $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG  # push the image
+    - |
+      if [[ "$CI_COMMIT_BRANCH" == "$CI_DEFAULT_BRANCH" ]]; then
+        docker image tag $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG $CI_REGISTRY_IMAGE/ci-build-runner:latest
+        docker push $CI_REGISTRY_IMAGE/ci-build-runner:latest
+      fi

CMakeLists.txt → {{cookiecutter.project_slug}}/CMakeLists.txt

 cmake_minimum_required(VERSION 3.16)
 
-project(CPP VERSION 0.1)
+project({{cookiecutter.project_slug}} VERSION 0.1)
 
 include(CheckCXXCompilerFlag)
 

{{cookiecutter.project_slug}}/LICENSE

+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{{cookiecutter.project_slug}}/README.md

+# {{cookiecutter.project_name}}
+
+{{cookiecutter.description}}
+
+## Description
+
+The repository can be used as a basis for new projects using C++ within ASTRON.
+The code is intended to be copied in a new repository and used as basis for the
+new project. After copying the code needs to be adjusted for the specific
+project. The template offers:
+
+- CI jobs for building, testing, and generating documentation
+
+  - A basic Docker file to be used in the CI
+  - A CMake project skeleton
+  - A Doxygen and Sphinx skeleton for documentation, combined with Breathe
+  - Formatting scripts for the code
+
+Note: The project is intended to be used for C++ projects without Fortran code.
+At the moment of writing there is no Fortran support for Ninja. This means the
+project needs to be changed to use `make`.
+
+## Getting started
+
+- Install all dependencies as listed in `docker/ci-runnner/Dockerfile`
+- Create build directory: `mkdir build`
+- Create the project: `cmake -DBUILD_TESTING=ON -DBUILD_DOCUMENTATION=ON -B ./build -G Ninja`
+- Build the project: `ninja -C ./build`
+
+Specific targets can also be build on a case per case basis use `ninja -C ./build/ -t targets`
+to list all of them.
+
+For instance:
+- Build the documentation: `ninja -C ./build/ sphinx`
+- Run unit tests: `ninja -C ./build/ test`
+- Install the project globally: ``ninja -C ./build/ install``
+- Clean caches: `ninja -C ./build/ clean`
+
+## Contributing
+
+To contribute, please create a feature branch and a "Draft" merge request. Upon
+completion, the merge request should be marked as ready and a reviewer should be
+assigned.
+
+## License
+This project is licensed under the Apache License Version 2.0.

doc/sphinx/conf.py → {{cookiecutter.project_slug}}/doc/sphinx/conf.py

@@ -18,6 +18,13 @@ import sys
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
+
+project = "{{cookiecutter.project_name}}"
+copyright = "2023, ASTRON"
+
+# TODO(): Extract version metadata from CMake and make available in Sphinx
+# version = ""
+
 extensions = [
     "breathe",
 ]

doc/sphinx/index.rst → {{cookiecutter.project_slug}}/doc/sphinx/index.rst

@@ -6,4 +6,7 @@
 Docs
 ====
 
-.. doxygenfunction:: Hello
+This text is added through ReStructuredText (RST) in Sphinx while the below
+is derived from Doxygen:
+
+.. doxygenindex::

ci/ubuntu_22_04-base → {{cookiecutter.project_slug}}/docker/ci-runner/Dockerfile

@@ -21,6 +21,5 @@ RUN export DEBIAN_FRONTEND=noninteractive && \
     graphviz \
     libboost-test-dev \
     ninja-build \
-		python3-breathe \
-	&& \
+    python3-breathe && \
 	rm -rf /var/lib/apt/lists/*