diff --git a/.gitignore b/.gitignore index f571b3f1..fc3179f1 100644 --- a/.gitignore +++ b/.gitignore @@ -32,8 +32,14 @@ docs/antsibull-docs.cfg docs/build.sh docs/build/ docs/conf.py +<<<<<<< HEAD docs/requirements.txt docs/rst/*.rst docs/temp-rst # Other tests/integration/inventory +======= + +# Collection specific +changelogs/.plugin-cache.yaml +>>>>>>> 11cecc3 (Add antsibull-changelog config) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70e9545f..575abd09 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -26,6 +26,12 @@ repos: args: [--unique] # always_run: true files: ^(\.config/dictionary\.txt)$ + - 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: diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml new file mode 100644 index 00000000..e69de29b diff --git a/changelogs/config.yaml b/changelogs/config.yaml new file mode 100644 index 00000000..76d87ca2 --- /dev/null +++ b/changelogs/config.yaml @@ -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 diff --git a/changelogs/fragments/.gitkeep b/changelogs/fragments/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/cspell.config.yaml b/cspell.config.yaml index 682f892e..0bdbb09b 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -21,3 +21,5 @@ ignorePaths: - src/ansiblelint/schemas/*.json # Other - "*.svg" + # Changelog specific + - changelogs/config.yaml diff --git a/tox.ini b/tox.ini index 5316ce37..1c56eb95 100644 --- a/tox.ini +++ b/tox.ini @@ -69,6 +69,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