From 85ddbc6b2ad492c490c524bddd73fe9e0af8b8db Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Wed, 11 Oct 2023 11:20:30 +0300 Subject: [PATCH] github: issue templates Add issue templates for bug reports, feature requests and new releases. --- .github/ISSUE_TEMPLATE/bug-report.yaml | 57 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 20 ++++++++ .github/ISSUE_TEMPLATE/new-release.md | 40 +++++++++++++++ 3 files changed, 117 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/new-release.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 000000000..efbef66f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,57 @@ +--- +name: Bug report +about: Create a report to help us improve +body: + - type: textarea + id: description + attributes: + label: Bug Description + description: Please describe the bug + value: "A clear and concise description of what the bug is" + validations: + required: true + - type: textarea + id: expected_behavior + attributes: + label: Expected behavior + description: Please describe the behavior you expected + value: "A clear and concise description of what you expected to happen" + validations: + required: true + - type: textarea + id: experienced_behavior + attributes: + label: Experienced behavior + description: Please describe the behavior you experienced + value: "A clear and concise description of what actually happened" + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce the behavior + description: Please explain the steps to reproduce the experienced behavior + value: "Steps to reproduce the behavior\n1.\n2.\n3.\n" + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Describe the environment you have + value: | + nri-plugin(s): + container runtime: + OS: + kernel: + Kubernetes version: + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context about the problem here + value: "Additional information about the bug" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 000000000..48c2f80a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +body: + - type: textarea + id: description + attributes: + label: Description + description: Describe the solution you'd like + value: "A clear and concise description of you want to happen." + validations: + required: true + - type: textarea + id: rationale + attributes: + label: Rationale + description: Describe why this is needed + value: "A clear and concise description of the use case and/or justification for the feature" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/new-release.md b/.github/ISSUE_TEMPLATE/new-release.md new file mode 100644 index 000000000..8ea7d7ae4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-release.md @@ -0,0 +1,40 @@ +--- +name: New release +about: Propose a new major release +title: Release v0.0.0 +labels: '' +assignees: '' + +--- + +## Release Process + + + +- [ ] Create and push new release branch +- Local release preparations (on the release branch) + - [ ] Run e2e tests + - [ ] Sync/tidy up dependencies. + - [ ] Run `go mod tidy`. + - [ ] Run `git commit -m 'go.mod,go.sum: update dependencies.' go.{mod,sum}`, if necessary. + - [ ] Run `git tag -a -m "NRI plugins $VERSION" $VERSION`. +- Publishing + - [ ] Push the tag with `git push $VERSION`. + - [ ] Check that new container images are published for the tag. + - ``` + for i in nri-resource-policy-topology-aware nri-resource-policy-balloons nri-resource-policy-template nri-config-manager nri-memory-qos nri-memtierd; do \ + skopeo inspect --format "$i: {{.Digest}}" docker://ghcr.io/containers/nri-plugins/$i:$VERSION; + done + ``` + - [ ] Finalize the new *draft* release created by CI + - [ ] Check that all artefacts (Helm charts) were uploaded + - [ ] Write the change log to the release. + - [ ] Get the change log OK'd by other maintainers. + - [ ] Publish the draft as a release. + - [ ] Verify that the Helm repo was updated + - [ ] Add a link to the tagged release in this issue. +- [ ] Close this issue.