Skip to content

Commit 2177c97

Browse files
martialblogmartialblog
authored
Merge pull request #129 from Icinga/feature/changelog
Add Antsibull Changelog configuration
2 parents d035fdd + 1f9476a commit 2177c97

40 files changed

+242
-0
lines changed

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ __pycache__/
77
# C extensions
88
*.so
99

10+
# Antsibull-changelog
11+
changelogs/.plugin-cache.yaml
12+
1013
# Distribution / packaging
1114
.Python
1215
build/

‎CHANGELOG.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
===========================
2+
Icinga.Icinga Release Notes
3+
===========================
4+
5+
.. contents:: Topics
6+
7+
8+
v0.2.0
9+
======
10+
11+
Release Summary
12+
---------------
13+
14+
This is the second major release
15+
16+
Major Changes
17+
-------------
18+
19+
- Add custom config files
20+
- Add icinga2_config_host var
21+
- Add management of CA Host port
22+
- Add object and feature Influxdb2Writer
23+
- Add object and feature LiveStatusListener
24+
- Add object and feature for ElasticsearchWriter
25+
- Add object and feature for GelfWriter
26+
- Add object and feature for IcingaDB
27+
- Add object and feature for OpenTsdbWriter
28+
- Add object and feature for PerfdataWriter
29+
- Add support for Fedora
30+
- Add support for icinga2_objects var outside of hostvars
31+
- Add validation of CA fingerprint during certificate requests
32+
33+
Minor Changes
34+
-------------
35+
36+
- Add CONTRIBUTING.md
37+
- Add bullseye to supported OS and fix license in role metadata
38+
- Add pylint to CI Workflows
39+
- Added documentation for custom config
40+
- Rework documentation structure
41+
- Update documentation
42+
43+
Bugfixes
44+
--------
45+
46+
- Fix Date type error
47+
- Fix empty custom config
48+
- Use correct version number into examples
49+
50+
v0.1.0
51+
======
52+
53+
Release Summary
54+
---------------
55+
56+
This is the initial release

‎CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ reviewed and merged if they suit some general guidelines:
1010
* For new functionality, proper tests are written
1111
* Changes should not solve certain problems on special environments
1212

13+
## Changelog fragments
14+
15+
This repository uses [Ansible Changelogs Fragments]. A basic changelog fragment is a .yaml or .yml file placed in the changelogs/fragments/ directory. Each file contains a yaml dict with keys like bugfixes or major_changes followed by a list of changelog entries of bugfixes or features.
16+
17+
Each PR must use a new fragment file rather than adding to an existing one, so we can trace the change back to the PR that introduced it. Example:
18+
19+
```
20+
cat changelogs/fragments/fix_issue_123.yml
21+
---
22+
bugfixes:
23+
- Fixes issue with something that was caused by something else
24+
```
25+
1326
## Signing our CLA
1427

1528
When creating a Pull Request (PR) within one of our projects on GitHub, you will be automatically asked to sign our [CLA]. You only have to sign the [CLA] once and it will apply to all of our projects.
@@ -34,3 +47,4 @@ tests as well.
3447
[pull request]: https://help.github.com/articles/using-pull-requests/
3548
[Molecule]: https://github.com/ansible-community/molecule/
3649
[CLA]: https://icinga.com/company/contributor-agreement/
50+
[Ansible Changelogs Fragments]: https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_changelogs.html

‎changelogs/changelog.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
ancestor: null
2+
releases:
3+
0.1.0:
4+
changes:
5+
release_summary: This is the initial release
6+
release_date: '2022-04-02'
7+
0.2.0:
8+
changes:
9+
bugfixes:
10+
- Fix Date type error
11+
- Fix empty custom config
12+
- Use correct version number into examples
13+
major_changes:
14+
- Add custom config files
15+
- Add icinga2_config_host var
16+
- Add management of CA Host port
17+
- Add object and feature Influxdb2Writer
18+
- Add object and feature LiveStatusListener
19+
- Add object and feature for ElasticsearchWriter
20+
- Add object and feature for GelfWriter
21+
- Add object and feature for IcingaDB
22+
- Add object and feature for OpenTsdbWriter
23+
- Add object and feature for PerfdataWriter
24+
- Add support for Fedora
25+
- Add support for icinga2_objects var outside of hostvars
26+
- Add validation of CA fingerprint during certificate requests
27+
minor_changes:
28+
- Add CONTRIBUTING.md
29+
- Add bullseye to supported OS and fix license in role metadata
30+
- Add pylint to CI Workflows
31+
- Added documentation for custom config
32+
- Rework documentation structure
33+
- Update documentation
34+
release_summary: This is the second major release
35+
release_date: '2022-08-23'

‎changelogs/config.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
changelog_filename_template: ../CHANGELOG.rst
2+
changelog_filename_version_depth: 0
3+
changes_file: changelog.yaml
4+
changes_format: combined
5+
ignore_other_fragment_extensions: true
6+
keep_fragments: false
7+
mention_ancestor: true
8+
new_plugins_after_name: removed_features
9+
notesdir: fragments
10+
prelude_section_name: release_summary
11+
prelude_section_title: Release Summary
12+
sanitize_changelog: true
13+
sections:
14+
- - major_changes
15+
- Major Changes
16+
- - minor_changes
17+
- Minor Changes
18+
- - breaking_changes
19+
- Breaking Changes / Porting Guide
20+
- - deprecated_features
21+
- Deprecated Features
22+
- - removed_features
23+
- Removed Features (previously deprecated)
24+
- - security_fixes
25+
- Security Fixes
26+
- - bugfixes
27+
- Bugfixes
28+
- - known_issues
29+
- Known Issues
30+
title: Icinga.Icinga
31+
trivial_section_name: trivial
32+
use_fqcn: true

‎changelogs/fragments/.keep

Whitespace-only changes.

‎plugins/modules/icinga2_apilistener.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
from ansible.module_utils.basic import AnsibleModule
22

3+
DOCUMENTATION = '''
4+
name: icinga2_apilistener
5+
'''
36

47
def main():
58
module = AnsibleModule(

‎plugins/modules/icinga2_apiuser.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
from ansible.module_utils.basic import AnsibleModule
22

3+
DOCUMENTATION = '''
4+
name: icinga2_apiuser
5+
'''
36

47
def main():
58
module = AnsibleModule(

‎plugins/modules/icinga2_checkcommand.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
from ansible.module_utils.basic import AnsibleModule
22

3+
DOCUMENTATION = '''
4+
name: icinga2_checkcommand
5+
'''
36

47
def main():
58
module = AnsibleModule(

‎plugins/modules/icinga2_checkercomponent.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
from ansible.module_utils.basic import AnsibleModule
22

3+
DOCUMENTATION = '''
4+
name: icinga2_checkercomponent
5+
'''
36

47
def main():
58
module = AnsibleModule(

0 commit comments

Comments
 (0)