mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-05 02:10:27 -07:00

Yusuke Tsutsumi 1ec54b286d prepping for 1.1.0-beta release

- Updating and documenting changelog creation process.
  antsibull-changelog was chosen because it is the standard tooling
  recommended by Ansible developers.
- Documenting the release process and several others so others can perform it in the
  future.
- Updating the integration tests to test against 2.13, which the 1.1.0
  final release will be certified for.
- Created changelog and update galaxy.yaml for 1.1.0-beta, which will be
  the next release.

2022-12-04 12:00:59 -08:00

2 KiB

Raw Blame History

Maintainer Documentation

See CONTRIBUTING.md for more tasks

CONTRIBUTING.md contains more instructions that could apply to contributors and not just maintainers (e.g. update ansible-core version).

CI GCP Project Configuration

To enable running integration tests, a test GCP project must be provided.

There is a Google-maintained CI project, ansible-gcp-ci, that is used for this purpose. For any questions or modification to this project, please contact a maintainer who is employed by Google.

Reviewing PRs

Merging PRs

Since running the full set of integration tests requires the usage of GCP credentials which are stored as a secret, maintainers must verify that tests pass the integration test run that runs on push to the master branch after accepting a change.

Release Process

Overview

The process is as follows:

Update the version of the collection.
Update the changelog.
Create a GitHub release to tag the repo and begin the publishing process.

Steps

Update Collection Version

Modify the galaxy.yaml file to the desired collection version:

version: {NEW_VERSION}

Ansible collection versions must follow SEMVER.

Alpha / beta releases are optional.

Update the changelog

Providing a valid CHANGELOG.rst is required for a certifiable collection release.

Use the antsibull-changelog tool to generate the changelog:

pip install antsibull-changelog
antsibull-changelog release

This will remove all the changelog fragments from ./changelogs/fragments and merge them into CHANGELOG.rst.

Tag a release

The release process is mostly automated, relying on GitHub releases and the following workflows:

2 KiB Raw Blame History