Update Issue Templates and workflows (#691)

This commit is contained in:
Juan Calderon-Perez 2023-09-04 21:17:23 -04:00 committed by GitHub
parent 7f663212e9
commit c1af339edc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 89 additions and 11 deletions

View File

@ -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:

View File

@ -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

32
.github/ISSUE_TEMPLATE/question.yml vendored Normal file
View File

@ -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

View File

@ -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'

View File

@ -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

View File

@ -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

View File

@ -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"