Skip to content

Commit a939da6

Browse files
andreashaerterandreashaerter
committed
Release preparations: v1.0.0
1 parent 503a6fb commit a939da6

File tree

6 files changed

+144
-1
lines changed

6 files changed

+144
-1
lines changed

‎CHANGELOG.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
=================================================
2+
foundata.proxmox Ansible collection Release Notes
3+
=================================================
4+
5+
.. contents:: Topics
6+
7+
v1.0.0
8+
======
9+
10+
Release Summary
11+
---------------
12+
13+
Release Date: 2025-12-09
14+
15+
First public release, providing all functionality and files.

‎changelogs/changelog.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
ancestor: null
3+
releases:
4+
1.0.0:
5+
changes:
6+
release_summary: 'Release Date: 2025-12-09
7+
8+
9+
First public release, providing all functionality and files.
10+
11+
'
12+
fragments:
13+
- 1.0.0-release.yaml
14+
release_date: '2025-12-09'

‎changelogs/config.yaml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Configuration file for antsibull-changelog (Ansible Changelog Tool)
2+
#
3+
# Refer to the official documentation for more information on this file:
4+
# https://ansible.readthedocs.io/projects/antsibull-changelog/changelog-configuration/
5+
6+
---
7+
8+
changelog_filename_template: "../CHANGELOG.rst"
9+
changelog_filename_version_depth: 0
10+
changelog_sort: "version_reversed"
11+
changelog_nice_yaml: true
12+
changes_file: "changelog.yaml"
13+
changes_format: "combined"
14+
notesdir: "fragments"
15+
keep_fragments: false
16+
archive_path_template: "./changelogs/fragments/archive"
17+
ignore_other_fragment_extensions: true
18+
prelude_section_name: "release_summary"
19+
prelude_section_title: "Release Summary"
20+
sections:
21+
- ["major_changes", "Major Changes"]
22+
- ["minor_changes", "Minor Changes"]
23+
- ["breaking_changes", "Breaking Changes / Porting Guide"]
24+
- ["deprecated_features", "Deprecated Features"]
25+
- ["removed_features", "Removed Features (previously deprecated)"]
26+
- ["security_fixes", "Security Fixes"]
27+
- ["bugfixes", "Bugfixes"]
28+
- ["known_issues", "Known Issues"]
29+
title: "foundata.proxmox Ansible collection"
30+
trivial_section_name: "trivial"
31+
mention_ancestor: true
32+
sanitize_changelog: true
33+
add_plugin_period: true
34+
use_fqcn: true
35+
vcs: "auto"
36+
output_formats:
37+
- "rst"

‎changelogs/fragments/00-fragment-template.txt‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
3+
# You can copy its contents into a .yaml file with a unique filename. A common
4+
# convention is to prefix the filename with the number of an issue or pull/merge
5+
# request. This file uses the .txt extension to prevent antsibull-changelog from
6+
# parsing it.
7+
#
8+
# Remove any sections that are not applicable to your changelog fragment.
9+
#
10+
# For more information, see the official documentation on
11+
# "Creating Changelog Fragments":
12+
# https://docs.ansible.com/ansible/latest/community/development_process.html#creating-changelog-fragments
13+
#
14+
# The file format is YAML, but the content of the values is typically written
15+
# in reStructuredText (not Markdown).
16+
17+
breaking_changes:
18+
- This section should only appear in major releases (MAJOR.0.0), according to semantic versioning.
19+
- It should include notes and `Links <https://example.com/>`__ to help existing users migrate.
20+
- Examples follow.
21+
- Dropped support for Ansible Core 2.15. Please update to at least Ansible Core 2.16 or continue using a previous version of this collection.
22+
- The ``foo_api`` module no longer accepts the ``password_plain`` option. Use ``password_secure`` instead. If you previously supplied passwords via ``password_plain``, consider changing them.
23+
- |
24+
This is a multiline string using YAML's block scalar syntax.
25+
It makes "quoting" 'easier'.
26+
27+
major_changes:
28+
- This section should only appear in major (MAJOR.0.0) (but are also technically allowed in minor (MAJOR.MINOR.0) releases), according to semantic versioning.
29+
- It should describe high-level changes or new features.
30+
- Examples follow.
31+
- Added support for a new ``acme_dns`` module, allowing DNS-based certificate challenges with additional providers.
32+
- The ``http_request`` module now supports custom headers and authentication tokens.
33+
34+
minor_changes:
35+
- This section can appear in all major (MAJOR.MINOR.PATCH) or minor (MAJOR.MINOR.0) releases, but not in patch (MAJOR.MINOR.PATCH) releases.
36+
- A typical minor change includes adding a new module, plugin, or option.
37+
- Examples follow.
38+
- ``foo`` - The module can now perform additional operations based on user-defined parameters.
39+
- ``baz lookup`` - Now supports retrieving data from Baz databases.
40+
- Optimized task execution performance by reducing unnecessary API calls.
41+
42+
deprecated_features:
43+
- This section should list features planned for removal in future major (MAJOR.0.0) releases.
44+
- Examples follow.
45+
- ``foo`` - The ``bar`` option has been deprecated. Use the ``username`` option instead.
46+
- ``send_request`` - The ``quic`` option has been deprecated. Use the ``protocol`` option instead.
47+
48+
removed_features:
49+
- This section can appear in major (MAJOR.0.0) or minor (MAJOR.MINOR.0) releases.
50+
- Typically used when the change is non-breaking from the collection's perspective (e.g. backend removal).
51+
- Examples follow.
52+
- ``foo`` - The ``baz`` option has been removed. The feature it controlled is no longer supported on target platforms.
53+
54+
security_fixes:
55+
- This section can appear in all releases.
56+
- Examples follow.
57+
- ``foo_api`` - The module unintentionally exposed passwords in plaintext to multiple servers when using the ``password_plain`` option.
58+
59+
bugfixes:
60+
- This section can appear in all releases.
61+
- Examples follow.
62+
- ``post`` - The module incorrectly sent PUT requests instead of POST requests.
63+
- ``get`` - The module no longer crashes when receiving invalid JSON data.
64+
65+
known_issues:
66+
- This section should describe known issues that are acknowledged but will not be fixed at this time.
67+
68+
trivial:
69+
- This section will not be shown in the final changelog.
70+
- Useful when a changelog fragment is required for every pull request, even for minor or internal changes.
71+
- Intended for changes that do not affect user-facing functionality, such as updates to tests or internal refactoring.

‎changelogs/fragments/archive/1.0.0-release.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
3+
release_summary: |
4+
Release Date: 2025-12-09
5+
6+
First public release, providing all functionality and files.

‎galaxy.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace: "foundata"
66
name: "proxmox"
7-
version: "0.1.0-dev"
7+
version: "1.0.0"
88
license:
99
# See https://spdx.org/licenses/ for valid IDs and syntax. The project's
1010
# REUSE.toml file provides detailed licensing and copyright information

0 commit comments

Comments
 (0)