Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable changelogs for collection #230

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ docs/rst/*.rst
docs/temp-rst
# Other
tests/integration/inventory

# 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 @@ -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:
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 @@ -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
Expand Down