mto79 / ansible_collection_mto79.transip

MTO79 - Ansible Collection - Transip

Ansible collection - mto79.transip

MTO79 Ansible collection for managing TransIP services.

Table of Contents

• Ansible collection - mto79.transip
  • Table of Contents
  • Requirements
  • Collection Structure
    • Plugins
    • Modules
    • Roles
  • Pre-commit
  • Changelogs
    • Generating changelogs
    • Release notes
  • Licensing

Requirements

Name	Minimum Version
ansible	2.11.0
ansible-lint	5.1.3
jinja2	2.11.3
ansible.posix	1.0.0

Collection Structure

Plugins

Plugin	Description	Tests

Modules

Module	Description	Tests

Roles

Role	Description	Tests
proxyservices.transip.dns	Ansible role for managing DNS by TransIP.

Usage:

export NEW_ROLE_NAME="new_role"
./add-role.sh ${NEW_ROLE_NAME}
# Or run the script and it will prompt you for the name

Pre-commit

Install pre-commit

pip install pre-commit

Set hooks in .pre-commit-config.yaml

repos:
- repo: https://github.com/ansible/ansible-lint.git
  rev: v4.2.0
  hooks:
    - id: ansible-lint
      files: \.(yaml|yml)$

Enable pre-commit for your git repository

$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

Testing pre-commit

pre-commit run --all-files
Ansible-lint.............................................................Passed

or just type:

git commit

Changelogs

This collection follows Semantic Versioning. More details on versioning can be found in the Ansible docs.

We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.

Releasing the current major version happens from the devel branch.

Generating changelogs

Install antsibull-changelog:

pip install antsibull-changelog

Initialize changelogs for your repository

antsibull-changelog init <path/to/your/collection>

Validate your changelog fragments

antsibull-changelog lint

Generate the changelog for your release

Create an entry of changelog in changelogs/changelog.yaml

Run antsibull-changelog release command (install antsibull tool before)

antsibull-changelog release --update-existing --version 1.0.0

Check changelogs/changelog.yaml file and generated changelog in CHANGELOG.rst and fix if need

Change version in galaxy.yaml file to the new one.

Commit and merge changes in changelog or/and docs

Git tag <version_tag> where <version_tag> is tag of the new version - for example 2.3.4 Push tags to upstream - git push upstream <version_tag>

wait until check and release jobs finish and check in galaxy that new version is uploaded: https://galaxy.ansible.com/containers/podman

Release notes

See CHANGELOG.rst.

Licensing

See LICENSE.