diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml new file mode 100644 index 000000000..85025f856 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yml @@ -0,0 +1,104 @@ +name: Bug Report +description: 🐞 Report a bug +labels: + - kind/bug +body: + - type: textarea + attributes: + label: Which area is this bug related to? + description: Choose the area(s) this bug is related to. + value: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + placeholder: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + validations: + required: true + - type: textarea + attributes: + label: What versions of software are you using? + description: Choose and fill in the applicable sections. + value: | + #### Go Project + + **Operating System and version:** + + **Go Pkg Version:** + + #### Node.js Project + + **Operating System and version:** + + **Node.js version:** + + **Yarn version:** + + **Project.json:** + + #### Web Browser + + **Operating System and version:** + + **Browser name and version:** + - type: textarea + attributes: + label: Bug Summary + description: A clear and concise description of what the bug is and steps to reproduce the behavior. + value: | + **Describe the bug:** + + **To Reproduce:** + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable + description: | + To get logs: + ci: please copy the github workflow output + api: please copy the terminal output + library: please copy the terminal output + registry: follow instruction under "Collecting Logs" to find log: https://github.com/devfile/registry-support/blob/main/TROUBLESHOOTING.md + devworkspace: copy the logs from the controller (kubectl logs deploy/devworkspace-controller -n $NAMESPACE) + test-automation: + api: follow instruction under "Running tests locally" to find test log: https://github.com/devfile/api/tree/main/test + library: follow instruction under "Running the tests locally" to find test log: https://github.com/devfile/library/tree/main/tests + devworkspace: copy the logs from the controller (kubectl logs deploy/devworkspace-controller -n $NAMESPACE) + integration-tests: please copy the build log under prow ci result for QE ingetration tests + - type: textarea + attributes: + label: Additional Context + description: Add any other context about the problem here. + - type: textarea + attributes: + label: Any workaround? + description: Describe the workaround if applicable. + - type: textarea + attributes: + label: Suggestion on how to fix the bug + description: Provide suggestion on how to fix the bug upon your investigation, if applicable. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2_user_story.yml b/.github/ISSUE_TEMPLATE/2_user_story.yml new file mode 100644 index 000000000..7a6546ccc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_user_story.yml @@ -0,0 +1,52 @@ +name: User Story +description: πŸ“ User story for new enhancement +labels: + - kind/user-story +body: + - type: textarea + attributes: + label: Which area is this user story related to? + description: Choose the area(s) this story is related to. + value: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + placeholder: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + validations: + required: true + - type: textarea + attributes: + label: User Story + description: Describe the user, action, and intention of the story then a clear and concise description of what needs to be done to achieve this story. + placeholder: As a ... I want to ..., so that ... + value: As a ... I want to ..., so that ... + validations: + required: true + - type: textarea + attributes: + label: Acceptance Criteria + description: Decide which specific steps need to be completed, outline subtasks. + value: | + - [ ] .... + - [ ] .... + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3_task.yml b/.github/ISSUE_TEMPLATE/3_task.yml new file mode 100644 index 000000000..bab3d6f23 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_task.yml @@ -0,0 +1,53 @@ +name: Task +description: πŸ”§ Issue for project support and quality assurance +labels: + - kind/task +body: + - type: textarea + attributes: + label: Which area is this issue related to? + description: Choose the area(s) this task is related to. + value: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + placeholder: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + validations: + required: true + - type: textarea + attributes: + label: Issue Description + description: A clear and concise description of what the task is. + validations: + required: true + - type: textarea + attributes: + label: Acceptance Criteria + description: Decide which specific steps need to be completed, outline subtasks. + value: | + - [ ] .... + - [ ] .... + - type: input + attributes: + label: Target Odo Version + description: Provide the target Odo version if this task is for QE integration test. + value: 'Target Odo version: ' \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/4_feature_request.yml b/.github/ISSUE_TEMPLATE/4_feature_request.yml new file mode 100644 index 000000000..63f012e59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_feature_request.yml @@ -0,0 +1,61 @@ +name: Feature Request +description: πŸ’‘ Suggest an idea for this project +labels: + - kind/enhancement +body: + - type: textarea + attributes: + label: Which area is this feature related to? + description: Choose the area(s) this feature is related to. + value: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + placeholder: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + validations: + required: true + - type: textarea + attributes: + label: Which functionality do you think we should add? + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + value: | + **Why is this needed? Is your feature request related to a problem?** + + **Detailed description:** + validations: + required: true + - type: textarea + 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 + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/5_documentation.yml b/.github/ISSUE_TEMPLATE/5_documentation.yml new file mode 100644 index 000000000..eab73da02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5_documentation.yml @@ -0,0 +1,43 @@ +name: Documentation +description: πŸ“– Suggest an update for devfile documentation +labels: + - area/documentation +body: + - type: textarea + attributes: + label: Which area is this documentation change related to? + description: Choose the area(s) this documentation change refer to. + value: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + placeholder: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + validations: + required: true + - type: textarea + attributes: + label: Issue Details + description: Provide a clear and concise description of the changes you are suggesting + value: | + **What mistake did you find / what is missing in the documentation?** + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/6_registry_update.yml b/.github/ISSUE_TEMPLATE/6_registry_update.yml new file mode 100644 index 000000000..ca2439a56 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/6_registry_update.yml @@ -0,0 +1,25 @@ +name: Emergency Registry Update +description: ⚠️ Request for an emergency registry update +title: "[Maintenance]: Promote stack changes to production" +labels: + - area/registry +assignees: + - michael-valdron +body: + - type: textarea + attributes: + label: Request Details + description: | + The staging devfile registry, https://registry.stage.devfile.io is refreshed upon each commit to main in this repository. + Production, https://registry.devfile.io, is promoted manually each Wednesday, as needed. + + If you are a stack or sample owner and need to request an urgent refresh of https://registry.devfile.io before Wednesday (for example if a stack is broken), + please fill out the issue template below. + value: | + **Stack name:** + + **Why is the refresh needed:** + + **Why the refresh cannot wait until the next regularly scheduled refresh:** + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/7_epic.yml b/.github/ISSUE_TEMPLATE/7_epic.yml new file mode 100644 index 000000000..abe7d798c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/7_epic.yml @@ -0,0 +1,52 @@ +name: Epic +description: πŸ“‘ Issue for a large goal +labels: + - kind/epic +body: + - type: textarea + attributes: + label: Which area is this epic related to? + description: Choose the area(s) this epic is related to. + value: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + > /area documentation + placeholder: | + > /area ci + > /area api + > /area library + > /area registry + > /area registry-viewer + > /area alizer + > /area devworkspace + > /area integration-tests + > /area test-automation + > /area releng + > /area landing-page + > /area documentation + validations: + required: true + - type: textarea + attributes: + label: Epic Story + description: A clear and concise description of what needs to be done to achieve this goal. + validations: + required: true + - type: textarea + attributes: + label: Acceptance Criteria + description: Decide which specific steps need to be completed, outline subtasks/child issues. + value: | + - [ ] .... + - [ ] .... + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 055029bbb..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -name: 🐞 Bug report -about: Report a bug -title: '' -labels: '' -assignees: '' - ---- - -/kind bug - - - -### Which area is this bug related to? - - - -> /area ci -> /area api -> /area library -> /area registry -> /area alizer -> /area devworkspace -> /area integration-tests -> /area test-automation -> /area releng -> /area landing-page - -## What versions of software are you using? - -### Go project - -**Operating System and version:** - -**Go Pkg Version:** - -### Node.js project - - - -**Operating System and version:** - -**Node.js version:** - -**Yarn version:** - -**Project.json:** - -### Web browser - - - -**Operating System and version:** - -**Browser name and version:** - -## Bug Summary - -**Describe the bug:** - - - -**To Reproduce:** - - - -## Expected behavior - - - -## Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable - - - -## Additional context - - - -### Any workaround? - - - -### Suggestion on how to fix the bug - - diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 63384be73..000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: "πŸ“– Documentation" -about: Suggest an update for devfile documentation -title: '' -labels: '' -assignees: '' - ---- - -/area documentation - -## Which area is this documentation change related to? - - - -> /area ci -> /area api -> /area library -> /area registry -> /area alizer -> /area devworkspace -> /area integration-tests -> /area test-automation -> /area releng -> /area landing-page - -## Issue details - - - -**What mistake did you find / what is missing in the documentation?** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 03f98e550..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -name: πŸ’‘ Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - - - -## Which area is this feature related to? - - - -> /area ci -> /area api -> /area library -> /area registry -> /area alizer -> /area devworkspace -> /area integration-tests -> /area test-automation -> /area releng -> /area documentation -> /area landing-page - -## Which functionality do you think we should add? - - - -**Why is this needed? Is your feature request related to a problem?** - -**Detailed description:** - -## Describe the solution you'd like - - - -## Describe alternatives you've considered - - - -## Additional context - - diff --git a/.github/ISSUE_TEMPLATE/registry_update.md b/.github/ISSUE_TEMPLATE/registry_update.md deleted file mode 100644 index 4615e5222..000000000 --- a/.github/ISSUE_TEMPLATE/registry_update.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: ⚠️ Emergency registry update -about: Request for an emergency registry update -title: '' -labels: '' -assignees: johnmcollier - ---- - -/area registry - - - -## Request details - -**Stack name:** - -**Why is the refresh needed:** - -**Why the refresh cannot wait until the next regularly scheduled refresh:** diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md deleted file mode 100644 index a3691f0ae..000000000 --- a/.github/ISSUE_TEMPLATE/task.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -name: πŸ”§ Task -about: Issue for project support and quality assurance -title: '' -labels: '' -assignees: '' - ---- - - - -## Which area is this issue related to? - - - -> /area ci -> /area api -> /area library -> /area registry -> /area alizer -> /area devworkspace -> /area integration-tests -> /area test-automation -> /area releng -> /area landing-page - -## Issue Description - - - -## Target Odo version - - - -> Target Odo version: diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md deleted file mode 100644 index 7e9085363..000000000 --- a/.github/ISSUE_TEMPLATE/user_story.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: πŸ“ User Story -about: User story for new enhancement -title: '' -labels: '' -assignees: '' ---- - -/kind user-story - -## Which area is this user story related to? - - - -> /area ci -> /area api -> /area library -> /area registry -> /area alizer -> /area devworkspace -> /area integration-tests -> /area test-automation -> /area releng -> /area landing-page - -## User Story - -As a ... I want to ..., so that ... - -## Acceptance Criteria - - -- [ ] .... -- [ ] ....