Skip to content

Commit bb0a5c8

Browse files
committed
Updated user guide and cookiecutter template
1 parent 933ca6a commit bb0a5c8

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

doc/user_guide/features/creating_a_release.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ Preparing a release
3737
* Verify that the version to be released does not already have a git tag or GitHub release
3838
* Create a new tag & push it to the default branch, which will trigger the GitHub workflow ``cd.yml``
3939

40+
Additionally, if enabled in your project config, the task will create an additional tag with pattern ``v<MAJOR_VERSION>``.
41+
This is especially useful if other projects use Github actions of your project, for example:
42+
43+
.. code-block:: yaml
44+
45+
uses: exasol/your_project/.github/actions/your_action@v1
46+
47+
Your ``PROJECT_CONFIG`` needs to have the flag ``create_major_version_tags=True``.
4048

4149
What to do if the release failed?
4250
+++++++++++++++++++++++++++++++++

project-template/{{cookiecutter.repo_name}}/noxconfig.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ class Config:
1919
path_filters: Iterable[str] = ()
2020
pyupgrade_args: Iterable[str] = ("--py{{cookiecutter.python_version_min | replace('.', '')}}-plus",)
2121
plugins: Iterable[object] = ()
22+
create_major_version_tags = False
2223

2324

2425
PROJECT_CONFIG = Config()

0 commit comments

Comments
 (0)