-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update readme with demo notice Update the README.md with a demo notice. This is the first pull request to leverage the [Terraform Module Releaser](https://github.com/techpivot/terraform-module-releaser) GitHub action which will create appropriate tags/releases based on existing Terraform modules.
- Loading branch information
1 parent
3d7fa61
commit b68d3c7
Showing
13 changed files
with
3 additions
and
285 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,5 @@ | ||
# Terraform Module Releaser — Demo Monorepo | ||
# AWS S3 Bucket Object Terraform Example Module | ||
|
||
This repository serves as a demo for the **[Terraform Module Releaser GitHub Action](https://github.com/techpivot/terraform-module-releaser)**, designed to simplify the management, versioning, and release of multiple Terraform modules within a monorepo. By automating the tagging, releasing, and documentation generation process, the action ensures seamless module management for large Terraform infrastructures. | ||
Creates S3 bucket objects with different configurations. | ||
|
||
## How It Works | ||
|
||
This demo repository leverages the [Terraform Module Releaser](https://github.com/techpivot/terraform-module-releaser) GitHub Action to: | ||
|
||
- Automatically determine and apply semantic versioning (major, minor, patch) to individual modules based on commit messages. | ||
- Create and manage module-specific tags, GitHub releases, and documentation. | ||
- Generate detailed wikis, including changelogs, usage examples, and `terraform-docs` output. | ||
|
||
For more details on the underlying GitHub Action, please visit the [Terraform Module Releaser GitHub Action repository](https://github.com/techpivot/terraform-module-releaser). | ||
|
||
## Demo | ||
|
||
To see the action in use, please refer to the following: | ||
|
||
- [**Pull Requests**](https://github.com/techpivot/terraform-modules-demo/pulls): Check out the pull requests in this repository to observe the action's automated tagging, release, and comment generation. | ||
- [**Releases**](https://github.com/techpivot/terraform-modules-demo/releases): Visit the Releases tab for detailed changelogs associated with various Terraform modules, including dynamically generated release notes for each module. | ||
- [**Wiki**](https://github.com/techpivot/terraform-modules-demo/wiki): The generated module documentation, including changelogs and usage details, is available in the repository's Wiki. This is automatically updated with each release. | ||
|
||
## Screenshots | ||
|
||
Below are examples of the outputs generated by the Terraform Module Releaser in this demo: | ||
|
||
- **Release Notes**: Each module's release details are summarized in the pull request comments and the GitHub releases section. | ||
- **Version Tags**: Observe how module-specific tags are applied based on the changes made. | ||
- **Wiki Entries**: Beautifully crafted module documentation, updated automatically with each release. | ||
|
||
_(Include relevant screenshots of the workflow in action, pull request comments, release notes, and wiki entries here.)_ | ||
|
||
## Getting Started | ||
|
||
To run this action in your own monorepo, follow the instructions in the **[Terraform Module Releaser GitHub Action README](https://github.com/techpivot/terraform-module-releaser)**. | ||
|
||
We welcome feedback, issues, and contributions to enhance the Terraform Module Releaser experience. Please visit the action's repository for more information on how to integrate it into your own workflows. | ||
|
||
Happy Terraforming! | ||
This is a demo Terraform module. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.