Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update catalog-info.yaml release annotation. #529

Merged
merged 1 commit into from
Oct 17, 2023
Merged

docs: Update catalog-info.yaml release annotation. #529

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion oeps/processes/oep-0055/decisions/0004-release-data-in-catalog-info-files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ We will use metadata in the ``catalog-info.yaml`` file to determine whether or n
Specification
*************

The data will be housed in a new annotation by the name of ``openedx.org/release``. Non-null values of this key will indicate the branch that should be tagged for releases.
The data will be housed in a new annotation by the name of ``openedx.org/release``. Non-null values of this key will indicate the branch that should be tagged for releases. A null value will indicate that the repository should not be tagged and a missing value will indicate that no decision has been made about the given repository.

.. code-block:: yaml
:caption: Annotating that the ``master`` branch should be tagged for new releases.
Expand All @@ -44,6 +44,12 @@ The data will be housed in a new annotation by the name of ``openedx.org/release
annotations:
openedx.org/release: null

.. code-block:: yaml
:caption: If the annotation is missing, we should consider that no decision has been made about tagging this repository.

metadata:
annotations:
...

Consequences
************
Expand Down