-
Notifications
You must be signed in to change notification settings - Fork 65
Create GitHub Issue Forms #1703
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
michael-valdron
wants to merge
16
commits into
devfile:main
Choose a base branch
from
michael-valdron:issue-forms
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
e36e293
github issue forms
michael-valdron 174532f
change areas dropdown to textarea due to technical limitation
michael-valdron eba1723
add documentation area under epic area choices
michael-valdron 15a97f6
Update .github/ISSUE_TEMPLATE/1_bug_report.yml
michael-valdron 97f1c93
Update .github/ISSUE_TEMPLATE/1_bug_report.yml
michael-valdron 4332e57
Update .github/ISSUE_TEMPLATE/1_bug_report.yml
michael-valdron 0382397
Update .github/ISSUE_TEMPLATE/1_bug_report.yml
michael-valdron 75ff246
Update .github/ISSUE_TEMPLATE/1_bug_report.yml
michael-valdron 3ba0f11
Update .github/ISSUE_TEMPLATE/3_task.yml
michael-valdron ea676a0
Update .github/ISSUE_TEMPLATE/1_bug_report.yml
michael-valdron 6997ac3
Update .github/ISSUE_TEMPLATE/1_bug_report.yml
michael-valdron f8c6429
Update .github/ISSUE_TEMPLATE/4_feature_request.yml
michael-valdron 1cb7bc1
Update .github/ISSUE_TEMPLATE/4_feature_request.yml
michael-valdron bd32e24
Update .github/ISSUE_TEMPLATE/5_documentation.yml
michael-valdron bbabb98
Update .github/ISSUE_TEMPLATE/6_registry_update.yml
michael-valdron a0cf3cf
Update .github/ISSUE_TEMPLATE/6_registry_update.yml
michael-valdron File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: <odo-version>' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| name: Emergency Registry Update | ||
| description: ⚠️ Request for an emergency registry update | ||
| title: "[Maintenance]: Promote stack <name> 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 | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be good here to include all registry promoters? E.g we could create a specific team in devfile org and mention/ping the team if such request is received? WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would https://github.com/orgs/devfile/teams/devfile-services-team work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure, because the registry promoters are a sub-group of this team.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To follow up here, though I think this would be a good idea, I don't believe you can add a GH organization team as an assignee. Closest solution here is that we can add registry promoters individually to all these issues, though the clean up of assignees might not be ideal, other solutions I can think of are:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you're right, I don't think there's a way to assign a gh org team. However, to clarify I meant to mention the gh org team in the issue description. This way all promoters get pinged, which could be of help in case some of us are off.