Skip to content

Commit

Permalink
Add antsibull-changelog config
Browse files Browse the repository at this point in the history
Signed-off-by: Abhijeet Kasurde <[email protected]>
  • Loading branch information
Akasurde committed Aug 21, 2024
1 parent ebfd8e0 commit 11cecc3
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ tests/integration/event_source_kafka/*.jks
docs/build.sh
docs/antsibull-docs.cfg
docs/conf.py

# Collection specific
changelogs/.plugin-cache.yaml
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ repos:
- id: trailing-whitespace
- id: end-of-file-fixer
language_version: python3
- repo: https://github.com/ansible-community/antsibull-changelog
rev: 0.29.0
hooks:
- id: antsibull-changelog-lint
# Enable this when we have working changelog file
# - id: antsibull-changelog-lint-changelog-yaml
- repo: https://github.com/koalaman/shellcheck-precommit
rev: v0.10.0
hooks:
Expand Down
Empty file added changelogs/changelog.yaml
Empty file.
37 changes: 37 additions & 0 deletions changelogs/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
add_plugin_period: true
changelog_filename_template: ../CHANGELOG.rst
changelog_filename_version_depth: 0
changelog_nice_yaml: false
changelog_sort: alphanumerical
changes_file: changelog.yaml
changes_format: combined
ignore_other_fragment_extensions: true
keep_fragments: false
mention_ancestor: true
new_plugins_after_name: removed_features
notesdir: fragments
output_formats:
- rst
prelude_section_name: release_summary
prelude_section_title: Release Summary
sanitize_changelog: true
sections:
- - major_changes
- Major Changes
- - minor_changes
- Minor Changes
- - breaking_changes
- Breaking Changes / Porting Guide
- - deprecated_features
- Deprecated Features
- - removed_features
- Removed Features (previously deprecated)
- - security_fixes
- Security Fixes
- - bugfixes
- Bugfixes
- - known_issues
- Known Issues
title: ansible.eda
trivial_section_name: trivial
use_fqcn: true
Empty file added changelogs/fragments/.gitkeep
Empty file.
2 changes: 2 additions & 0 deletions cspell.config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ ignorePaths:
- src/ansiblelint/schemas/*.json
# Other
- "*.svg"
# Changelog specific
- changelogs/config.yaml
6 changes: 6 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,12 @@ description =
Run all test types: sanity, unit, integration
py{39,310,311,312,313}: with {basepython}

[testenv:changelog]
deps = antsibull-changelog
description = Builds documentation with changelog
commands =
antsibull-changelog generate

[testenv:lint]
deps = pre-commit
description = Run linters
Expand Down

0 comments on commit 11cecc3

Please sign in to comment.