From 8d33a32501cb3435b2076332c37cd715b939b4ce Mon Sep 17 00:00:00 2001 From: Boldlink-SIG automation user <106749487+boldlinksig@users.noreply.github.com> Date: Fri, 2 Feb 2024 17:17:18 +0000 Subject: [PATCH] Updated files (#20) --- .../1-feature-request-terraform.yml | 71 ++++++++++++++ .../ISSUE_TEMPLATE/2-bug-report-terraform.yml | 98 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 18 ++++ .github/workflows/auto-merge.yaml | 4 + 4 files changed, 191 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-feature-request-terraform.yml create mode 100644 .github/ISSUE_TEMPLATE/2-bug-report-terraform.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1-feature-request-terraform.yml b/.github/ISSUE_TEMPLATE/1-feature-request-terraform.yml new file mode 100644 index 0000000..284b749 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-feature-request-terraform.yml @@ -0,0 +1,71 @@ +name: "💡 Terraform Module Feature Request" +description: Create a new ticket for a new feature request +title: "💡 [REQUEST] - " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + # Thank you for opening an Terraform Module feature/enhancement request! + + This form is intended as a way to request additional functionality for this Terraform Module. + + This may include requests such as adding additional arguments, attributes, documentation, additional validation for arguments, etc. + + If the absense of the requested feature is causing unexpected behavior in the Terraform Module, the "Terraform Module Report Bug" form should be used. + + - type: textarea + id: concise-description + attributes: + label: Describe the Feature + description: A clear and concise description of what the feature is. + placeholder: What is the feature about? + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected. + placeholder: What happened? + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: | + Is your feature request related to a problem/challenge you are trying + to solve? + + Please provide some additional context of why this feature or + capability will be valuable. + validations: + required: true + + - type: textarea + id: ideal-solution + attributes: + label: Describe Ideal Solution + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives-considered + attributes: + label: Alternatives Considered + description: Explain alternative solutions or features considered. + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: | + Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-bug-report-terraform.yml b/.github/ISSUE_TEMPLATE/2-bug-report-terraform.yml new file mode 100644 index 0000000..09f9bfb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report-terraform.yml @@ -0,0 +1,98 @@ +name: Terraform Module Bug Report +description: File a bug report +title: "🐛 [Bug]: <title>" +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + # Thank you for raising a bug report! 🐛 + + Before submitting a bug report, we ask that you first search existing issues to see if someone else may have experienced the same issue. This helps to keep all relevant information in one place, including any potential workarounds. + + - type: textarea + id: environment + attributes: + label: Environment + description: Anything that will help us triage the bug. + placeholder: | + - OS: [e.g. Linux, OSX, WSL, etc] + - Version [e.g. 10.15] + - Module version + - Terraform version + validations: + required: true + + - type: markdown + attributes: + value: | + # Description + + In the next few fields, please provide any useful information you can around what resources are affected, what you expected to happen, and what actually happened. There is also a field to optionally provide a small snippet of any relevant error or panic output. + + Note that there is a section later in the form to provide more complete Terraform configuration and logging information. These fields should instead be thought of as the place to briefly describe the bug. + + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. example@example.com + validations: + required: false + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What should have happened? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - type: textarea + id: log_snippet + attributes: + label: Relevant Error/Panic Output Snippet + description: | + If applicable, provide a relevant snippet from the error or panic output. This will be rendered as `shell`, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + render: shell + validations: + required: false + + - type: textarea + id: repro + attributes: + label: Steps to Reproduce + description: Please list the steps required to reproduce the issue. + validations: + required: true + + - type: textarea + id: debug_logs + attributes: + label: Debug Output + description: | + If possible, please paste, upload, or link to a file or Gist containing debug logs. See note above for additional information on file size restrictions and encrypting. + + To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html). + validations: + required: false + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..196182a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,18 @@ +blank_issues_enabled: false + +contact_links: + - name: Organisation + url: https://github.com/boldlink + about: See all our public repositories. + + - name: Cloud and Devops Acceleration + url: https://boldlink.io + about: Our central location for more resources + + - name: Articles + url: https://boldlink.io/articles/ + about: Follow this link for our articles about Cloud and DevOps + + - name: Discussions + url: https://github.com/orgs/boldlink/discussions + about: Our community discussions. diff --git a/.github/workflows/auto-merge.yaml b/.github/workflows/auto-merge.yaml index 828ec50..93862c2 100644 --- a/.github/workflows/auto-merge.yaml +++ b/.github/workflows/auto-merge.yaml @@ -6,8 +6,12 @@ on: - opened - reopened +permissions: read-all + jobs: auto-merge: + permissions: + pull-requests: write uses: boldlink/terraform-module-support/.github/workflows/auto-merge.yaml@main secrets: AUTOMATION_TOKEN: ${{ secrets.AUTOMATION_TOKEN }}