felixfontein

Docs presentation

• public Ansible docsite

  • show https://docs.ansible.com/ansible/latest/collections/
  • "we want to have a similar docsite for our collection"

• setup venv and install ansible-core and antsibull-docs in there

  $ python -m venv ~/antsibull-demo-venv
  $ . ~/antsibull-demo-venv/bin/activate

felixfontein

# Create and activate Python virtual environment
python3 -m venv antsibull-test
cd antsibull-test
. bin/activate

# Install ansible-core and antsibull-docs
pip install ansible-core antsibull-docs

# Create collection directory
mkdir collections

felixfontein

# Copyright: (c) 2014, James Tanner <tanner.jc@gmail.com>
# Copyright: (c) 2018, Ansible Project
# Copyright: (c) 2020, Felix Fontein
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

# Parts taken from Ansible's ansible-doc sources

import argparse
import json
import sys

felixfontein

Ansible 2.10 Release Notes

v2.10.0a3

felixfontein

The collection name used in ansible/ansible is ansible.builtin.

1. Module/plugin deprecation:
   • deprecated entry in DOCUMENTATION with:
     • why, alternative (required)
     • either removed_in: <version> or removed_at_date: <date>
     • (removed_from_collection is automatically inserted if not present)
   • deprecation entry in meta/runtime.yml with:
     • warning_text (optional)

• either removal_version: or removal_date:

felixfontein

#!/usr/bin/python3
import os
import sys

import yaml


COLLECTION_NAME = 'community.general'

if len(sys.argv) > 1:

felixfontein

Versioning, deprecation and changelogs for community.general and community.network

This is a release candidate (version 3.0.0-rc1).

My idea is to have this as a pinned and locked (i.e. readonly except for repo members) issue in both repos. That issue should be used to announce release-related things, like "The next xxx release is planned for " or "We plan to do a 1.1.0 release on August 15 after ansible-base 2.10 has been released". (Locking it prevents this issue to accumulate spam. It should be announce only.) The "introduction" section below should be seen in this context :)

Introduction

This issue describes how and when community.general is released, and to announce updates to the release/versioning schedule. The next section (Next release) is always updated to contain the next version to be released. Other changes to this first post are always announced by separate posts in this issue.

felixfontein

# Encoding: must be UTF-8
# Entries must be reStructuredText (https://en.wikipedia.org/wiki/ReStructuredText)

meta:
  extends:
    file: changelog-1.x.yml
    branch: stable-1.x   # optional, in case previous changelog is in another branch

versions:
  2.0.0:

felixfontein

cloud/amazon/aws_s3_bucket_facts.py
cloud/amazon/cloudformation_facts.py
cloud/amazon/cloudfront_facts.py
cloud/amazon/ecs_service_facts.py
cloud/amazon/efs_facts.py
cloud/amazon/lambda_facts.py
cloud/azure/azure_rm_availabilityset_facts.py
cloud/azure/azure_rm_containerinstance_facts.py
cloud/azure/azure_rm_dnsrecordset_facts.py
cloud/azure/azure_rm_dnszone_facts.py

felixfontein

Run bin/ansible-test sanity --test validate-modules --docker-no-pull --docker.

Put output into ignore-output.txt, and reduce to all ERROR: lines for validate-modules which inform about errors to be added or removed/ignored.

Run this script to update test/sanity/ignore.txt accordingly.