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 antsibull-changelog and add GitHub workflow for changelog validation #78

Merged
merged 5 commits into from
Feb 13, 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
21 changes: 21 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -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
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Terraform Provider for Ansible

The Terraform Provider for Ansible provides a more straightforward and robust means of executing Ansible automation from Terraform than local-exec. Paired with the inventory plugin in [the Ansible cloud.terraform collection](https://github.com/ansible-collections/cloud.terraform), users can run Ansible playbooks and roles on infrastructure provisioned by Terraform. The provider also includes integrated ansible-vault support.
The Terraform Provider for Ansible provides a more straightforward and robust means of executing Ansible automation from Terraform than local-exec. Paired with the inventory plugin in [the Ansible cloud.terraform collection](https://github.com/ansible-collections/cloud.terraform), users can run Ansible playbooks and roles on infrastructure provisioned by Terraform. The provider also includes integrated ansible-vault support.

This provider can be [found in the Terraform Registry here](https://registry.terraform.io/providers/ansible/ansible/latest).

Expand Down Expand Up @@ -56,15 +56,20 @@ make test
### Examples
The [examples](./examples/) subdirectory contains a usage example for this provider.

## Release notes

See the [generated changelog](https://github.com/ansible/terraform-provider-ansible/tree/main/CHANGELOG.rst).

## Releasing

To release a new version of the provider:

1. Update the version number in https://github.com/ansible/terraform-provider-ansible/blob/main/examples/provider/provider.tf
2. Run `go generate` to regenerate docs
3. Commit changes
4. Push a new tag (this should trigger an automated release process to the Terraform Registry)
5. Verify the new version is published at https://registry.terraform.io/providers/ansible/ansible/latest
3. Run `antsibull-changelog release --version <version>` to release a new version of the project.
4. Commit changes
5. Push a new tag (this should trigger an automated release process to the Terraform Registry)
6. Verify the new version is published at https://registry.terraform.io/providers/ansible/ansible/latest

## Licensing

Expand Down
33 changes: 33 additions & 0 deletions changelogs/config.yaml
Original file line number Diff line number Diff line change
@@ -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: The Terraform Provider for Ansible
trivial_section_name: trivial
use_semantic_versioning: true
Empty file added changelogs/fragments/.keep
Empty file.
2 changes: 2 additions & 0 deletions changelogs/fragments/aws_example.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
trivial:
- "Added aws example to create ec2 instance with terraform and install nginx with ansible (https://github.com/ansible/terraform-provider-ansible/pull/9)."
2 changes: 2 additions & 0 deletions changelogs/fragments/gplv3_licensing.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
trivial:
- "Add GPLv3 licensing (https://github.com/ansible/terraform-provider-ansible/issues/36)."
2 changes: 2 additions & 0 deletions changelogs/fragments/inventory_race_conditions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
bugfixes:
- provider/resource_playbook - Fix race condition between multiple ansible_playbook resources (https://github.com/ansible/terraform-provider-ansible/issues/38).
2 changes: 2 additions & 0 deletions changelogs/fragments/update_dependencies.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- "Update dependencies (google.golang.org/grpc and golang.org/x/net) to resolve security alerts https://github.com/ansible/terraform-provider-ansible/security/dependabot (https://github.com/ansible/terraform-provider-ansible/pull/72)."
2 changes: 2 additions & 0 deletions changelogs/fragments/use_sdkv2.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- "Updates the provider to use SDKv2 (https://github.com/ansible/terraform-provider-ansible/issues/39)."
Loading