From 386a3103ede94c9341522fed85527459e3a1e5a2 Mon Sep 17 00:00:00 2001 From: Bryant Biggs Date: Thu, 29 Jun 2023 18:56:30 -0400 Subject: [PATCH] feat: Repo has moved to [terraform-aws-modules](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster) organization (#9) --- .github/CODEOWNERS | 2 - .github/CODE_OF_CONDUCT.md | 76 ---------------------------- .github/images/bridgecrew.svg | 1 - .github/workflows/lock.yml | 21 ++++++++ .github/workflows/pr-title.yml | 52 +++++++++++++++++++ .github/workflows/release.yml | 37 ++++++++++++++ .github/workflows/stale-actions.yaml | 32 ++++++++++++ .releaserc.json | 29 ++++++++++- LICENSE | 25 --------- README.md | 21 +++++--- UPGRADE-2.0.md | 12 ++--- examples/README.md | 11 ++-- examples/basic/README.md | 2 +- examples/complete/README.md | 2 +- examples/connect/README.md | 2 +- 15 files changed, 200 insertions(+), 125 deletions(-) delete mode 100644 .github/CODEOWNERS delete mode 100644 .github/CODE_OF_CONDUCT.md delete mode 100644 .github/images/bridgecrew.svg create mode 100644 .github/workflows/lock.yml create mode 100644 .github/workflows/pr-title.yml create mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/stale-actions.yaml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 9ea52ce..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,2 +0,0 @@ -# Default owners - required for review/approval -* @bryantbiggs diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md deleted file mode 100644 index 13556e5..0000000 --- a/.github/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or - advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic - address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at contact@clowd.haus. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/.github/images/bridgecrew.svg b/.github/images/bridgecrew.svg deleted file mode 100644 index ce2873d..0000000 --- a/.github/images/bridgecrew.svg +++ /dev/null @@ -1 +0,0 @@ - Group 29Created with Sketch. diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml new file mode 100644 index 0000000..6b6c9ce --- /dev/null +++ b/.github/workflows/lock.yml @@ -0,0 +1,21 @@ +name: 'Lock Threads' + +on: + schedule: + - cron: '50 1 * * *' + +jobs: + lock: + runs-on: ubuntu-latest + steps: + - uses: dessant/lock-threads@v4 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + issue-comment: > + I'm going to lock this issue because it has been closed for _30 days_ ⏳. This helps our maintainers find and focus on the active issues. + If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. + issue-inactive-days: '30' + pr-comment: > + I'm going to lock this pull request because it has been closed for _30 days_ ⏳. This helps our maintainers find and focus on the active issues. + If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. + pr-inactive-days: '30' diff --git a/.github/workflows/pr-title.yml b/.github/workflows/pr-title.yml new file mode 100644 index 0000000..cb32a0f --- /dev/null +++ b/.github/workflows/pr-title.yml @@ -0,0 +1,52 @@ +name: 'Validate PR title' + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + steps: + # Please look up the latest version from + # https://github.com/amannn/action-semantic-pull-request/releases + - uses: amannn/action-semantic-pull-request@v5.0.2 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + # Configure which types are allowed. + # Default: https://github.com/commitizen/conventional-commit-types + types: | + fix + feat + docs + ci + chore + # Configure that a scope must always be provided. + requireScope: false + # Configure additional validation for the subject based on a regex. + # This example ensures the subject starts with an uppercase character. + subjectPattern: ^[A-Z].+$ + # If `subjectPattern` is configured, you can use this property to override + # the default error message that is shown when the pattern doesn't match. + # The variables `subject` and `title` can be used within the message. + subjectPatternError: | + The subject "{subject}" found in the pull request title "{title}" + didn't match the configured pattern. Please ensure that the subject + starts with an uppercase character. + # For work-in-progress PRs you can typically use draft pull requests + # from Github. However, private repositories on the free plan don't have + # this option and therefore this action allows you to opt-in to using the + # special "[WIP]" prefix to indicate this state. This will avoid the + # validation of the PR title and the pull request checks remain pending. + # Note that a second check will be reported if this is enabled. + wip: true + # When using "Squash and merge" on a PR with only one commit, GitHub + # will suggest using that commit message instead of the PR title for the + # merge commit, and it's easy to commit this by mistake. Enable this option + # to also validate the commit message for one commit PRs. + validateSingleCommit: false diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..81f6747 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,37 @@ +name: Release + +on: + workflow_dispatch: + push: + branches: + - main + - master + paths: + - '**/*.tpl' + - '**/*.py' + - '**/*.tf' + - '.github/workflows/release.yml' + +jobs: + release: + name: Release + runs-on: ubuntu-latest + # Skip running release workflow on forks + if: github.repository_owner == 'terraform-aws-modules' + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + persist-credentials: false + fetch-depth: 0 + + - name: Release + uses: cycjimmy/semantic-release-action@v3 + with: + semantic_version: 18.0.0 + extra_plugins: | + @semantic-release/changelog@6.0.0 + @semantic-release/git@10.0.0 + conventional-changelog-conventionalcommits@4.6.3 + env: + GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_TOKEN }} diff --git a/.github/workflows/stale-actions.yaml b/.github/workflows/stale-actions.yaml new file mode 100644 index 0000000..5037995 --- /dev/null +++ b/.github/workflows/stale-actions.yaml @@ -0,0 +1,32 @@ +name: 'Mark or close stale issues and PRs' +on: + schedule: + - cron: '0 0 * * *' + +jobs: + stale: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v6 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + # Staling issues and PR's + days-before-stale: 30 + stale-issue-label: stale + stale-pr-label: stale + stale-issue-message: | + This issue has been automatically marked as stale because it has been open 30 days + with no activity. Remove stale label or comment or this issue will be closed in 10 days + stale-pr-message: | + This PR has been automatically marked as stale because it has been open 30 days + with no activity. Remove stale label or comment or this PR will be closed in 10 days + # Not stale if have this labels or part of milestone + exempt-issue-labels: bug,wip,on-hold + exempt-pr-labels: bug,wip,on-hold + exempt-all-milestones: true + # Close issue operations + # Label will be automatically removed if the issues are no longer closed nor locked. + days-before-close: 10 + delete-branch: true + close-issue-message: This issue was automatically closed because of stale in 10 days + close-pr-message: This PR was automatically closed because of stale in 10 days diff --git a/.releaserc.json b/.releaserc.json index 7885cfa..66b3eef 100644 --- a/.releaserc.json +++ b/.releaserc.json @@ -1,7 +1,9 @@ { "branches": [ - "main" + "main", + "master" ], + "ci": false, "plugins": [ [ "@semantic-release/commit-analyzer", @@ -15,6 +17,29 @@ "preset": "conventionalcommits" } ], - "@semantic-release/github" + [ + "@semantic-release/github", + { + "successComment": "This ${issue.pull_request ? 'PR is included' : 'issue has been resolved'} in version ${nextRelease.version} :tada:", + "labels": false, + "releasedLabels": false + } + ], + [ + "@semantic-release/changelog", + { + "changelogFile": "CHANGELOG.md", + "changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file." + } + ], + [ + "@semantic-release/git", + { + "assets": [ + "CHANGELOG.md" + ], + "message": "chore(release): version ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}" + } + ] ] } diff --git a/LICENSE b/LICENSE index 437811b..d9a10c0 100644 --- a/LICENSE +++ b/LICENSE @@ -174,28 +174,3 @@ of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2021 Clowd Haus, LLC. - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md index 38fa94d..e171a95 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,23 @@ # AWS MSK Kafka Cluster Terraform module +## ⚠️ Module has moved to `terraform-aws-modules` + +This module has moved to the terraform-aws-modules organization. Users will need to update their module source: + +```diff +- source = "clowdhaus/msk-kafka-cluster/aws" ++ source = "terraform-aws-modules/msk-kafka-cluster/aws" +``` + Terraform module which creates AWS MSK (Managed Streaming for Kafka) resources. ## Usage -See [`examples`](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/tree/main/examples) directory for working examples to reference: +See [`examples`](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/tree/master/examples) directory for working examples to reference: ```hcl module "msk_kafka_cluster" { - source = "clowdhaus/msk-kafka-cluster/aws" + source = "terraform-aws-modules/msk-kafka-cluster/aws" name = local.name kafka_version = "3.4.0" @@ -115,10 +124,10 @@ module "msk_kafka_cluster" { ## Examples -Examples codified under the [`examples`](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/tree/main/examples) are intended to give users references for how to use the module(s) as well as testing/validating changes to the source code of the module. If contributing to the project, please be sure to make any appropriate updates to the relevant examples to allow maintainers to test your changes and to keep the examples up to date for users. Thank you! +Examples codified under the [`examples`](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/tree/master/examples) are intended to give users references for how to use the module(s) as well as testing/validating changes to the source code of the module. If contributing to the project, please be sure to make any appropriate updates to the relevant examples to allow maintainers to test your changes and to keep the examples up to date for users. Thank you! -- [Basic](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/tree/main/examples/basic) -- [Complete](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/tree/main/examples/complete) +- [Basic](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/tree/master/examples/basic) +- [Complete](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/tree/master/examples/complete) ## Requirements @@ -237,4 +246,4 @@ No modules. ## License -Apache-2.0 Licensed. See [LICENSE](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/blob/master/LICENSE). diff --git a/UPGRADE-2.0.md b/UPGRADE-2.0.md index 187dd71..b7b8eec 100644 --- a/UPGRADE-2.0.md +++ b/UPGRADE-2.0.md @@ -63,7 +63,7 @@ Note: Only the relevant changes are shown for brevity ```hcl module "msk_kafka_cluster" { - source = "clowdhaus/msk-kafka-cluster/aws" + source = "terraform-aws-modules/msk-kafka-cluster/aws" version = "1.2" broker_node_ebs_volume_size = 20 @@ -72,7 +72,7 @@ module "msk_kafka_cluster" { tags = { Blueprint = local.name - GithubRepo = "github.com/clowdhaus/terraform-aws-msk-kafka-cluster" + GithubRepo = "github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster" } } ``` @@ -81,7 +81,7 @@ module "msk_kafka_cluster" { ```hcl module "msk_kafka_cluster" { - source = "clowdhaus/msk-kafka-cluster/aws" + source = "terraform-aws-modules/msk-kafka-cluster/aws" version = "2.0" broker_node_storage_info = { @@ -94,7 +94,7 @@ module "msk_kafka_cluster" { tags = { Blueprint = local.name - GithubRepo = "github.com/clowdhaus/terraform-aws-msk-kafka-cluster" + GithubRepo = "github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster" } } ``` @@ -103,7 +103,7 @@ module "msk_kafka_cluster" { ```diff module "msk_kafka_cluster" { - source = "clowdhaus/msk-kafka-cluster/aws" + source = "terraform-aws-modules/msk-kafka-cluster/aws" - version = "1.2" + version = "2.0" @@ -119,7 +119,7 @@ module "msk_kafka_cluster" { tags = { Blueprint = local.name - GithubRepo = "github.com/clowdhaus/terraform-aws-msk-kafka-cluster" + GithubRepo = "github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster" } } ``` diff --git a/examples/README.md b/examples/README.md index 1b6d4e7..f417c0a 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,8 @@ -# Terraform AWS MSK Kafka Cluster examples +# Examples -- [Basic](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/tree/main/examples/basic) -- [Complete](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/tree/main/examples/complete) -- [Connect](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/tree/main/examples/connect) +Please note - the examples provided serve two primary means: + +1. Show users working examples of the various ways in which the module can be configured and features supported +2. A means of testing/validating module changes + +Please do not mistake the examples provided as "best practices". It is up to users to consult the AWS service documentation for best practices, usage recommendations, etc. diff --git a/examples/basic/README.md b/examples/basic/README.md index 2769edb..ef36464 100644 --- a/examples/basic/README.md +++ b/examples/basic/README.md @@ -77,4 +77,4 @@ No inputs. | [zookeeper\_connect\_string\_tls](#output\_zookeeper\_connect\_string\_tls) | A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphbetically | -Apache-2.0 Licensed. See [LICENSE](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/blob/master/LICENSE). diff --git a/examples/complete/README.md b/examples/complete/README.md index 30a579c..8028e64 100644 --- a/examples/complete/README.md +++ b/examples/complete/README.md @@ -83,4 +83,4 @@ No inputs. | [zookeeper\_connect\_string\_tls](#output\_zookeeper\_connect\_string\_tls) | A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphbetically | -Apache-2.0 Licensed. See [LICENSE](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/blob/master/LICENSE). diff --git a/examples/connect/README.md b/examples/connect/README.md index 815f55a..5aab2f4 100644 --- a/examples/connect/README.md +++ b/examples/connect/README.md @@ -80,4 +80,4 @@ No inputs. | [zookeeper\_connect\_string\_tls](#output\_zookeeper\_connect\_string\_tls) | A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphbetically | -Apache-2.0 Licensed. See [LICENSE](https://github.com/clowdhaus/terraform-aws-msk-kafka-cluster/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-msk-kafka-cluster/blob/master/LICENSE).