Add support for changelogs (#20) (#21)

(cherry picked from commit b4d25da)

Co-authored-by: Mike Graves <[email protected]>

.github/workflows/changelog.yml

@@ -0,0 +1,21 @@
+---
+name: Changelog
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - labeled
+      - unlabeled
+      - synchronize
+    branches:
+      - main
+      - stable-*
+
+jobs:
+  changelog:
+    uses: ansible-network/github_actions/.github/workflows/changelog.yml@main

README.md

@@ -61,14 +61,19 @@ Then you can run acceptance tests with `make testacc`.
 
 The [examples](./examples/) subdirectory contains usage examples for this provider.
 
+## Release notes
+
+See the [generated changelog](https://github.com/ansible/terraform-provider-aap/tree/main/CHANGELOG.rst).
+
 ## Releasing
 
 To release a new version of the provider:
 
 1. Run `make generatedocs` to format the example files and regenerate docs using terraform-plugin-docs [tfplugindocs installation guide](https://github.com/hashicorp/terraform-plugin-docs?tab=readme-ov-file#installation).
-2. Commit changes
-3. Push a new tag (this should trigger an automated release process to the Terraform Registry)
-4. Verify the new version is published at https://registry.terraform.io/providers/ansible/aap/latest
+2. Run `antsibull-changelog release --version <version>` to release a new version of the project.
+3. Commit changes
+4. Push a new tag (this should trigger an automated release process to the Terraform Registry). The tag version *must* start with "v", for example, v1.2.3.
+5. Verify the new version is published at https://registry.terraform.io/providers/ansible/aap/latest
 
 ## Licensing
 

changelogs/config.yaml

@@ -0,0 +1,33 @@
+changelog_filename_template: ../CHANGELOG.rst
+changelog_filename_version_depth: 0
+changes_file: changelog.yaml
+changes_format: combined
+ignore_other_fragment_extensions: true
+is_other_project: true
+keep_fragments: false
+mention_ancestor: true
+new_plugins_after_name: removed_features
+notesdir: fragments
+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: Terraform Provider for AAP
+trivial_section_name: trivial
+use_semantic_versioning: true