Repo: Add issue forms and issue labeler workflow DRAFT #1028
Conversation
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
Vercel Previews Deployed
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This requires that repo Settings > General > Features > Issues is enabled. I do not have permissions to view Settings.
Jira: CE-1027
Community users are already creating docs issues with out guidance. This PR creates bug and feature request issue forms/templates. Additionally, I added an issue labeler workflow that run when an issue is created or edited so that a product label is applied based on the product checked in the issue form. The product select list contains "Other product" and "No product" as choices. Those trigger a "Triage" label. I set "Terraform" as the default selected product. I cannot have "Select..." or blank value as list entry b/c it counts as a selected value (GH feature request). Validation is limited to required or not required.
The tech writers have ongoing discussions about where community users should open docs issues and the "where" may vary by product.
Benefit: Automatic triage. Community users must choose a product when creating an issue. HashiCorp employees are expected to still use either Jira or Asana to create tickets.
Architecture
New
.github/ISSUE_TEMPLATEdirectory to house the YAML for the issue forms.bug-report.yml: Example of a docs bug issue form. Selecting a product from the Product drop-down is required.feature-request.yml: Example of a docs feature request issue form. Selecting a product from the Product drop-down is required.config.yml: 1) prevents a blank issue form; 2) example of how to code a link to open a Nomad issue in the Nomad repo. This option appears on the Issue chooser modal window..github/workflowsAdd
label-issues.yml, which uses GHA Advanced Issue Labeler from Red Hat Plumbers. The label config file for the workflow is.github/advanced-issue-labeler.yml. The issue label does not need to exist in the repo prior to running the workflow. The workflow creates the label if it does not exist, but does not add a color to the label.User flow:
Example screens
Screenshots from the implementation in my personal fork of web-unified-docs.
Issue chooser
Bug issue
Feature issue
Issue list with labels