From 38bf4f97888176383db516a909d90d4f56cce5c5 Mon Sep 17 00:00:00 2001 From: Sagi Shnaidman Date: Thu, 31 Jul 2025 16:48:23 +0300 Subject: [PATCH] Add template based issue and PR Signed-off-by: Sagi Shnaidman --- .github/ISSUE_TEMPLATE.md | 89 ----------------- .github/ISSUE_TEMPLATE/bug_report.yml | 105 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 50 ++++++++++ .github/pull_request_template.yml | 86 +++++++++++++++++ 4 files changed, 241 insertions(+), 89 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index e71604c..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,89 +0,0 @@ - - -**Is this a BUG REPORT or FEATURE REQUEST? (leave only one on its own line)** - -/kind bug - -/kind feature - -**Description** - - - -**Steps to reproduce the issue:** - -1. - -2. - -3. - -**Describe the results you received:** - - -**Describe the results you expected:** - - -**Additional information you deem important (e.g. issue happens only occasionally):** - - -**Version of the `containers.podman` collection:** -**Either git commit if installed from git: `git show --summary`** -**Or version from `ansible-galaxy` if installed from galaxy: `ansible-galaxy collection list | grep containers.podman`** - -``` -(paste your output here) -``` - -**Output of `ansible --version`:** - -``` -(paste your output here) -``` - -**Output of `podman version`:** - -``` -(paste your output here) -``` - -**Output of `podman info --debug`:** - -``` yaml -(paste your output here) -``` - -**Package info (e.g. output of `rpm -q podman` or `apt list podman`):** - -``` -(paste your output here) -``` - -**Playbok you run with ansible (e.g. content of `playbook.yaml`):** - -``` yaml -(paste your output here) -``` - -**Command line and output of ansible run with high verbosity** - -**Please NOTE: if you submit a bug about idempotency, run the playbook with `--diff` option, like:** - -`ansible-playbook -i inventory --diff -vv playbook.yml` - -``` -(paste your output here) -``` - -**Additional environment details (AWS, VirtualBox, physical, etc.):** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..e218e3e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,105 @@ +name: Bug Report +description: File a bug report +title: "[BUG]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + Please update your version of Podman Ansible modules to the latest possible and retry your command before creating an issue. + + - type: textarea + id: description + attributes: + label: Description + description: Briefly describe the problem you are having + placeholder: Tell us what you see! + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: What are the reproduction steps? + placeholder: | + 1. Run command... + 2. See error... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What actually happened? + validations: + required: true + + - type: textarea + id: collection-version + attributes: + label: Collection version + description: Output of `ansible-galaxy collection list | grep containers.podman` or `git show --summary` + render: shell + validations: + required: true + + - type: textarea + id: ansible-version + attributes: + label: Ansible version + description: Output of `ansible --version` + render: shell + validations: + required: true + + - type: textarea + id: podman-version + attributes: + label: Podman version + description: Output of `podman version` + render: shell + validations: + required: true + + - type: textarea + id: playbook + attributes: + label: Playbook + description: Content of your playbook (use real values, not templated parameters like {{ variable_name }}!) + placeholder: | + - name: Create container + containers.podman.podman_container: + name: my-container + image: nginx:latest + state: present + render: yaml + validations: + required: false + + - type: textarea + id: command-output + attributes: + label: Command output + description: Command line and output of ansible run with high verbosity (use `--diff -vv` for idempotency issues) + render: shell + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional information + description: Any additional information (environment details, package info, etc.) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..b157658 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,50 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[FEATURE]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! + + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is + placeholder: I'm always frustrated when... + validations: + required: false + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered + validations: + required: false + + - type: textarea + id: use-case + attributes: + label: Use case + description: Describe your use case and how this feature would help + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here + validations: + required: false diff --git a/.github/pull_request_template.yml b/.github/pull_request_template.yml new file mode 100644 index 0000000..62db36f --- /dev/null +++ b/.github/pull_request_template.yml @@ -0,0 +1,86 @@ +name: Pull Request +description: Create a pull request +body: + - type: markdown + attributes: + value: | + Thanks for contributing to the containers.podman collection! + + - type: dropdown + id: type + attributes: + label: Type of change + description: What type of change does this PR introduce? + options: + - Bug fix (non-breaking change which fixes an issue) + - New feature (non-breaking change which adds functionality) + - Breaking change (fix or feature that would cause existing functionality to not work as expected) + - Documentation update + - CI/CD improvements + - Refactoring + - Other + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Describe what this PR does + placeholder: Brief description of the changes... + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation and context + description: Why is this change required? What problem does it solve? + placeholder: Fixes issue #123, adds support for... + validations: + required: false + + - type: textarea + id: testing + attributes: + label: How has this been tested? + description: Describe the tests that you ran to verify your changes + placeholder: | + - [ ] Unit tests + - [ ] Integration tests + - [ ] Manual testing + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please confirm the following + options: + - label: I have performed a self-review of my own code + required: false + - label: I have tested my changes thoroughly + required: false + - label: I have made corresponding changes to the documentation + required: false + - label: I have added tests that prove my fix is effective or that my feature works + required: false + - label: If I used AI tools, I have disclosed their use in the description of my changes and reviewed the output for accuracy + required: false + + - type: textarea + id: breaking-changes + attributes: + label: Breaking changes + description: If this is a breaking change, describe what breaks and how to migrate + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional notes + description: Any additional information or notes for reviewers + validations: + required: false