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

Update version tagging enforcement documentation #312

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Update version tagging enforcement documentation #312

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
23 changes: 8 additions & 15 deletions docs/policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,28 +66,21 @@ The playbook will fail if any new collection releases are not properly tagged.

In case of violations, the release manager must preform the following steps:

1. First, the collection must be pinned to the previous tagged release in
the `ansible-VERSION.build` file.
1. First, the collection must be restricted to the previous tagged release in
the `ansible-VERSION.constraints` file.

Take the `community.docker` collection as an example.
In `8/ansible-8.build`, it has
Take the `community.docker` collection as an example. If its version 3.9.0
was released and correctly tagged, and 3.9.1 was released but not correctly
tagged, add

```
community.docker: >=3.4.0,<4.0.0
community.docker: <3.9.1
```

`,<4.0.0` would need to be replaced with `,<= RELEASE` where `RELEASE` is
the previous tagged version.
For instance, if community.docker 3.9.1 is released but not properly tagged
while community.docker 3.9.0 is properly tagged, change the line to

```
community.docker: >=3.4.0,<=3.9.0
```
2. Commit only the changed `ansible-VERSION.build` file:
2. Commit only the changed `ansible-VERSION.constraints` file:

```
git add 8/ansible-8.build
git add 8/ansible-8.constraints
git commit -m "pin community.docker to previous release"
```
3. Rerun the release playbook.
Expand Down