From c1af339edcb39ccd72399a4eec31a994d284ff86 Mon Sep 17 00:00:00 2001 From: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Date: Mon, 4 Sep 2023 21:17:23 -0400 Subject: [PATCH] Update Issue Templates and workflows (#691) --- .../{bug_report.yml => bug-report.yml} | 6 ++- .github/ISSUE_TEMPLATE/feature-request.yml | 37 +++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 32 ++++++++++++++++ .github/workflows/ci.yml | 14 ++++--- .github/workflows/docker.yml | 3 +- .github/workflows/helm-test.yml | 4 +- .github/workflows/model-check.yml | 4 +- 7 files changed, 89 insertions(+), 11 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.yml => bug-report.yml} (96%) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml similarity index 96% rename from .github/ISSUE_TEMPLATE/bug_report.yml rename to .github/ISSUE_TEMPLATE/bug-report.yml index 6fbd3c2..31da4ae 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,8 @@ -name: Bug report +name: "☢️ Bug Report" +title: "\U0001F41B [Bug]: " description: Create a report to help us improve Serge. -labels: ["bug"] +labels: ["☢️ Bug"] + body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..e3aaabe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,37 @@ +name: "✏️ Feature Request" +title: "\U0001F680 [Feature]: " +description: Suggest an idea to improve this project. +labels: ["✏️ Feature"] + +body: + - type: markdown + id: notice + attributes: + value: | + ### Notice + - Don't forget you can ask your questions in our [Discord server](https://discord.gg/62Hc6FEYQH). + - If you think this is just a bug, open the issue with the **☢️ Bug Report** template. + - type: textarea + id: description + attributes: + label: "Feature Description" + description: "A clear and detailed description of the feature you would like to see added." + placeholder: "Explain your feature clearly, and in detail." + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: "Additional Context (optional)" + description: "If you have something else to describe, write them here." + placeholder: "Write here what you can describe differently." + - type: checkboxes + id: terms + attributes: + label: "Checklist:" + description: "By submitting this issue, you confirm that:" + options: + - label: "I have checked for existing issues that describe my suggestion prior to opening this one." + required: true + - label: "I understand that improperly formatted feature requests may be closed without explanation." + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..aae283d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,32 @@ +name: "🤔 Question" +title: "\U0001F917 [Question]: " +description: Ask a question so we can help you +labels: ["🤔 Question"] + +body: + - type: markdown + id: notice + attributes: + value: | + ### Notice + - Don't forget you can ask your questions in our [Discord server](https://discord.gg/62Hc6FEYQH). + - If you think this is just a bug, open the issue with the **☢️ Bug Report** template. + - If you have a suggestion for a Serge feature you would like to see, open the issue with the **✏️ Feature Request** template. + - type: textarea + id: description + attributes: + label: "Question Description" + description: "A clear and detailed description of the question." + placeholder: "Explain your question clearly, and in detail." + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: "Checklist:" + description: "By submitting this issue, you confirm that:" + options: + - label: "I have checked for existing issues that describe my questions prior to opening this one." + required: true + - label: "I understand that improperly formatted questions may be closed without explanation." + required: true \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 72cd964..144e69e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,6 +11,7 @@ on: - "docker-compose.dev.yml" - ".github/ISSUE_TEMPLATE/*.yml" - ".github/dependabot.yml" + - ".github/release-drafter.yml" pull_request: branches: - "*" @@ -21,6 +22,7 @@ on: - "docker-compose.dev.yml" - ".github/ISSUE_TEMPLATE/*.yml" - ".github/dependabot.yml" + - ".github/release-drafter.yml" workflow_dispatch: release: types: [published, edited] @@ -29,13 +31,13 @@ jobs: check-json-syntax: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Check syntax of models JSON file run: cat ./api/src/serge/data/models.json | jq -e . validate-models-schema: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Validate models.json against a json schema uses: cardinalby/schema-validator-action@v3 with: @@ -46,7 +48,7 @@ jobs: python-unit-tests: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-python@v4 with: python-version: "3.11" @@ -62,7 +64,7 @@ jobs: check-sh-files: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: luizm/action-sh-checker@v0.7.0 env: SHFMT_OPTS: "-s" @@ -72,7 +74,7 @@ jobs: check-api-code: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-python@v4 with: python-version: "3.11" @@ -89,7 +91,7 @@ jobs: check-web-code: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-node@v3 with: node-version: '20' diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index fc50404..1372030 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -11,6 +11,7 @@ on: - "docker-compose.dev.yml" - ".github/ISSUE_TEMPLATE/*.yml" - ".github/dependabot.yml" + - ".github/release-drafter.yml" pull_request: branches: - "*" @@ -28,7 +29,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Docker metadata id: meta uses: docker/metadata-action@v4 diff --git a/.github/workflows/helm-test.yml b/.github/workflows/helm-test.yml index 84b2091..1cdaa4b 100644 --- a/.github/workflows/helm-test.yml +++ b/.github/workflows/helm-test.yml @@ -11,6 +11,7 @@ on: - "docker-compose.dev.yml" - ".github/ISSUE_TEMPLATE/*.yml" - ".github/dependabot.yml" + - ".github/release-drafter.yml" pull_request: branches: - "*" @@ -21,6 +22,7 @@ on: - "docker-compose.dev.yml" - ".github/ISSUE_TEMPLATE/*.yml" - ".github/dependabot.yml" + - ".github/release-drafter.yml" workflow_dispatch: release: types: [published, edited] @@ -30,7 +32,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 diff --git a/.github/workflows/model-check.yml b/.github/workflows/model-check.yml index 9d935c5..c23b5d8 100644 --- a/.github/workflows/model-check.yml +++ b/.github/workflows/model-check.yml @@ -11,6 +11,7 @@ on: - "docker-compose.dev.yml" - ".github/ISSUE_TEMPLATE/*.yml" - ".github/dependabot.yml" + - ".github/release-drafter.yml" pull_request: branches: - "*" @@ -21,6 +22,7 @@ on: - "docker-compose.dev.yml" - ".github/ISSUE_TEMPLATE/*.yml" - ".github/dependabot.yml" + - ".github/release-drafter.yml" workflow_dispatch: release: types: [published, edited] @@ -31,7 +33,7 @@ jobs: model-health-check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-python@v4 with: python-version: "3.11"