Updates templates and bumps version

Author: ferreteleco

.github/workflows/ci-auto-release.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   run-tests:
-    name: Run Unit Tests
+    name: Auto Release Unit Testing
     uses: ./.github/workflows/ci-tests.yml
 
     permissions:

.github/workflows/ci-tests.yml

@@ -14,6 +14,7 @@ on:
 jobs:
 
   run_unit_tests:
+    name: Unit Tests
 
     runs-on: ubuntu-20.04
 

CHANGELOG.md

@@ -7,6 +7,20 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
+## [**2.0.1**] - 2023-04-05
+
+## Added
+
+-
+
+## Changed
+
+-
+
+### Fixed
+
+- Adds fixes to cpp templates.
+
 ## [**2.0.0**] - 2023-04-04
 
 ## Added

CHANGES.md

@@ -1,23 +1,11 @@
 ## Added
 
-- Action for auto releases in pushes to master. Release tag is set to 'latest' automatically.
-- Action for tagged releases in tag pushes.
-- Action for running unit tests inside the repo.
-- Template action for python's tagged release.
-- Template action for python's auto release.
-- Updated project description and files.
-- Template action for generic's tagged release.
-- Template action for generic's auto release.
-- Template action for cpp's tagged release.
-- Template action for cpp's auto release.
-- Auto-releases and tagged releases now will pick body from this file.
-- Upgrade project documentation.
+-
 
 ## Changed
 
-- Interface and variable selection.
-- Simplified config. process with less options.
+-
 
 ### Fixed
 
-- Fixes along the actions, both templated and the ones for this very repository.
+- Adds fixes to cpp templates.

README.md

@@ -4,7 +4,7 @@ This repository can be used for adding Github Actions and templates to an existi
 
 ## Version
 
-Current version is 2.0.0 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+Current version is 2.0.1 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 Project's version should be updated, when applicable:
 

{{ cookiecutter.__github_folder }}/_/cpp/workflows/ci-auto-release-cpp.yml

@@ -17,8 +17,16 @@ on:
 
 jobs:
   run-tests:
-    name: Run Unit Tests
+    name: Auto Release Unit Testing
     uses: ./.github/workflows/ci-tests-cpp.yml
+    ##########################################################################
+    # Please uncomment and fill the following if the image comes from a private repository
+    # More info in: https://docs.github.com/en/actions/security-guides/encrypted-secrets
+    ##########################################################################
+    # secrets:
+    #   RepositoryUser: {{ '${{ secrets.RepositoryUser }}' }}
+    #   RepositoryPass: {{ '${{ secrets.RepositoryPass }}' }}
+    ##########################################################################
 
     ############################################################################
     # Minimum permissions required by EnricoMi/publish-unit-test-result-action@v2
@@ -62,7 +70,7 @@ jobs:
         id: release-build
         working-directory: .
         run: |
-          cmake -S . -B build -DCMAKE_BUILD_TYPE={{ '${{BUILD_TYPE}}' }}
+          cmake -S . -B build -DCMAKE_BUILD_TYPE={{ '${{env.BUILD_TYPE}}' }}
           cmake --build build
 
       - name: Package application
@@ -92,5 +100,4 @@ jobs:
           generate_release_notes: true
           # body_path: {{ '${{ github.workspace }}' }}/CHANGES.md
           files: |
-            {{ '${{ github.workspace }}' }}/build/packages/*.tar.gz
             {{ '${{ github.workspace }}' }}/build/packages/*.deb

{{ cookiecutter.__github_folder }}/_/cpp/workflows/ci-tagged-release-cpp.yml

@@ -17,8 +17,16 @@ on:
 
 jobs:
   run-tests:
-    name: Run Unit Tests
+    name: Tagged Release Unit Testing
     uses: ./.github/workflows/ci-tests-cpp.yml
+    ##########################################################################
+    # Please uncomment and fill the following if the image comes from a private repository
+    # More info in: https://docs.github.com/en/actions/security-guides/encrypted-secrets
+    ##########################################################################
+    # secrets:
+    #   RepositoryUser: {{ '${{ secrets.RepositoryUser }}' }}
+    #   RepositoryPass: {{ '${{ secrets.RepositoryPass }}' }}
+    ##########################################################################
 
     ############################################################################
     # Minimum permissions required by EnricoMi/publish-unit-test-result-action@v2
@@ -62,7 +70,7 @@ jobs:
         id: release-build
         working-directory: .
         run: |
-          cmake -S . -B build -DCMAKE_BUILD_TYPE={{ '${{BUILD_TYPE}}' }}
+          cmake -S . -B build -DCMAKE_BUILD_TYPE={{ '${{env.BUILD_TYPE}}' }}
           cmake --build build
 
       - name: Package application
@@ -80,5 +88,4 @@ jobs:
           generate_release_notes: true
           # body_path: {{ '${{ github.workspace }}' }}/CHANGES.md
           files: |
-            {{ '${{ github.workspace }}' }}/build/packages/*.tar.gz
             {{ '${{ github.workspace }}' }}/build/packages/*.deb

{{ cookiecutter.__github_folder }}/_/cpp/workflows/ci-tests-cpp.yml

@@ -9,6 +9,10 @@ env:
   ##############################################################################
   TEST_TARGET_NAME: test_target_name
   ##############################################################################
+  # Target path where to find tests executable. Replace the variable accordingly.
+  ##############################################################################
+  TEST_EXECUTABLE_PATH: ./build/tests
+  ##############################################################################
   # Build type for the test run. Defaults to Debug.
   ##############################################################################
   BUILD_TYPE: Debug
@@ -23,6 +27,16 @@ on:
   # Relevant where using it as a reusable workflow
   ##############################################################################
   workflow_call:
+    ##########################################################################
+    # Please uncomment and fill the following if the image comes from a private repository
+    # More info in: https://docs.github.com/en/actions/security-guides/encrypted-secrets
+    ##########################################################################
+    # secrets:
+    #   RepositoryUser:
+    #     required: true
+    #   RepositoryPass:
+    #     required: true
+    ##########################################################################
 
 jobs:
 
@@ -63,14 +77,15 @@ jobs:
         id: tests-build
         working-directory: .
         run: |
-          cmake -S . -B build -DCMAKE_BUILD_TYPE={{ '${{BUILD_TYPE}}' }}
+          cmake -S . -B build -DCMAKE_BUILD_TYPE={{ '${{env.BUILD_TYPE}}' }}
           cmake --build build -t {{ '${{ env.TEST_TARGET_NAME }}' }}
 
       - name: Run tests
         id: tests-run
         working-directory: .
         run: |
-          ./build/test/{{ '${{ env.TEST_TARGET_NAME }}' }} --reporter junit -o junit/ci-result-junit.xml
+          mkdir junit
+          {{ '${{env.TEST_EXECUTABLE_PATH}}' }}/{{ '${{ env.TEST_TARGET_NAME }}' }} --reporter junit -o junit/ci-result-junit.xml
 
       - name: Publish Unit Test Results
         id: tests-publish

{{ cookiecutter.__github_folder }}/_/cpp/workflows/cpp-ci-checklist.md

@@ -5,6 +5,7 @@ Be sure to properly fine-tune the generated actions before committing it to the
 ## ci-tests-cpp
 
 - [ ] [**ENV**] The target name for the test executable has been configured.
+- [ ] [**ENV**] The location for the test executable has been configured.
 - [ ] [**JOB-CONF**] The target Docker image where to run the test has been specified (defaults to
   *ubuntu:jammy*). **Delete it if not needed**.
     - [ ] [**JOB-CONF**] The credentials for acquiring the Docker image (if needed) have been configured

{{ cookiecutter.__github_folder }}/_/python/workflows/ci-auto-release-python.yml

@@ -22,7 +22,7 @@ on:
 
 jobs:
   run-tests:
-    name: Run Unit Tests
+    name: Auto Release Unit Testing
     uses: ./.github/workflows/ci-tests-python.yml
 
     ############################################################################