Documented PublishReleaseNotes.

This commit is contained in:
Patrick Lehmann
2025-09-05 00:46:25 +02:00
parent 1c99a4a914
commit ee869dead5
8 changed files with 379 additions and 108 deletions

View File

@@ -1,96 +0,0 @@
.. _JOBTMPL/PublishReleaseNotes:
PublishReleaseNotes
###################
This job creates a Release Page on GitHub.
**Release Template in Markdown**:
.. parsed-literal::
**Automated Release created on: ${{ steps.getVariables.outputs.datetime }}**
# New Features
* tbd
* tbd
# Changes
* tbd
* tbd
# Bug Fixes
* tbd
* tbd
# Documentation
* tbd
* tbd
# Unit Tests
* tbd
* tbd
----------
# Related Issues and Pull-Requests
* tbd
* tbd
**Behavior:**
1. Extract information from environment variables provided by GitHub Actions.
2. Create a Release Page on GitHub
**Dependencies:**
* :gh:`actions/create-release` (unmaintained)
Instantiation
*************
Simple Example
==============
.. code-block:: yaml
jobs:
Release:
uses: pyTooling/Actions/.github/workflows/Release.yml@r5
Complex Example
===============
.. code-block:: yaml
jobs:
Release:
uses: pyTooling/Actions/.github/workflows/Release.yml@r5
if: startsWith(github.ref, 'refs/tags')
needs:
- Package
Parameters
**********
This job template needs no input parameters.
Secrets
*******
This job template needs no secrets.
Results
*******
This job template has no output parameters.

View File

@@ -7,7 +7,6 @@ The category *publish* provides workflow templates implementing
* :ref:`JOBTMPL/PublishTestResults` -
* :ref:`JOBTMPL/PublishCoverageResults` -
* :ref:`JOBTMPL/PublishReleaseNotes` -
* :ref:`JOBTMPL/PublishToGitHubPages` -
.. toctree::
@@ -15,5 +14,4 @@ The category *publish* provides workflow templates implementing
PublishTestResults
PublishCoverageResults
PublishReleaseNotes
PublishToGitHubPages