diff --git a/.github/ISSUE_TEMPLATE/.common.yaml b/.github/ISSUE_TEMPLATE/.common.yaml index 55515d7fd2..c7b79912b1 100644 --- a/.github/ISSUE_TEMPLATE/.common.yaml +++ b/.github/ISSUE_TEMPLATE/.common.yaml @@ -4,88 +4,89 @@ # WARNING: After updating this file, run `yarn sync-issue-templates` # -- id: issue-labels - type: checkboxes - attributes: - label: '📜 Issue Labels' - options: - - label: 'Please familiarize yourself with the issue labels used in this project: [LABELS.md](https://github.com/backstage/backstage/blob/master/LABELS.md)' - required: true -- id: search-terms - type: textarea - attributes: - label: '🔎 Search Terms' - render: plain - description: | - What search terms did you use when trying to find similar issues? - placeholder: | - List of keywords you searched for before creating this issue. Write them down here so that others can find this issue more easily and help provide feedback. +body: + - id: issue-labels + type: checkboxes + attributes: + label: '📜 Issue Labels' + options: + - label: 'Please familiarize yourself with the issue labels used in this project: [LABELS.md](https://github.com/backstage/backstage/blob/master/LABELS.md)' + required: true + - id: search-terms + type: textarea + attributes: + label: '🔎 Search Terms' + render: plain + description: | + What search terms did you use when trying to find similar issues? + placeholder: | + List of keywords you searched for before creating this issue. Write them down here so that others can find this issue more easily and help provide feedback. - e.g. "catalog github rate limited", "http root service configurer", "scaffolder template include", "entity card title" - validations: - required: true -- id: project-area - type: dropdown - attributes: - label: '🗃️ Project Area' - description: What project area is this issue closest related to? This will help find an owner for the issue faster. - options: - - Unknown - - Auditor - - Auth - - Catalog - - CLI Tooling - - Core Framework - - Design System - - Documentation - - Events System - - Home - - Kubernetes Plugin - - Notifications - - OpenAPI Tooling - - Permission Framework - - Search - - Software Templates - - TechDocs - validations: - required: true -- type: dropdown - id: integration - attributes: - label: '🔗 External Integration' - description: Is this issue related to an integration with any particular external system? - options: - - N/A - - AWS - - Azure - - Azure DevOps - - Bitbucket Cloud - - Bitbucket Server - - GCP - - Gerrit - - Gitea - - GitHub - - GitLab - - Other - validations: - required: true -- id: read-code-of-conduct - type: checkboxes - attributes: - label: 'Have you read the Code of Conduct?' - options: - - label: 'I have read the [Code of Conduct](https://github.com/backstage/backstage/blob/master/CODE_OF_CONDUCT.md)' - required: true -- id: willing-to-submit-pr - type: dropdown - attributes: - label: Are you willing to submit PR? - description: This is absolutely not required, but we are happy to guide you in the contribution process. - options: - - Undecided - - Yes, and I have enough information to get started - - Yes, but I would like some more guidance - - No, but I'm happy to collaborate on a PR with someone else - - No, I don't have time to work on this right now - validations: - required: true + e.g. "catalog github rate limited", "http root service configurer", "scaffolder template include", "entity card title" + validations: + required: true + - id: project-area + type: dropdown + attributes: + label: '🗃️ Project Area' + description: What project area is this issue closest related to? This will help find an owner for the issue faster. + options: + - Unknown + - Auditor + - Auth + - Catalog + - CLI Tooling + - Core Framework + - Design System + - Documentation + - Events System + - Home + - Kubernetes Plugin + - Notifications + - OpenAPI Tooling + - Permission Framework + - Search + - Software Templates + - TechDocs + validations: + required: true + - type: dropdown + id: integration + attributes: + label: '🔗 External Integration' + description: Is this issue related to an integration with any particular external system? + options: + - N/A + - AWS + - Azure + - Azure DevOps + - Bitbucket Cloud + - Bitbucket Server + - GCP + - Gerrit + - Gitea + - GitHub + - GitLab + - Other + validations: + required: true + - id: read-code-of-conduct + type: checkboxes + attributes: + label: 'Have you read the Code of Conduct?' + options: + - label: 'I have read the [Code of Conduct](https://github.com/backstage/backstage/blob/master/CODE_OF_CONDUCT.md)' + required: true + - id: willing-to-submit-pr + type: dropdown + attributes: + label: Are you willing to submit PR? + description: This is absolutely not required, but we are happy to guide you in the contribution process. + options: + - Undecided + - Yes, and I have enough information to get started + - Yes, but I would like some more guidance + - No, but I'm happy to collaborate on a PR with someone else + - No, I don't have time to work on this right now + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/sync.js b/.github/ISSUE_TEMPLATE/sync.js index ec025ccd29..b9252c3407 100755 --- a/.github/ISSUE_TEMPLATE/sync.js +++ b/.github/ISSUE_TEMPLATE/sync.js @@ -10,7 +10,7 @@ const COMMON_FILE = path.join(TEMPLATES_DIR, '.common.yaml'); // Read the common fields from .common.yaml const commonDoc = yaml.parseDocument(fs.readFileSync(COMMON_FILE, 'utf8')); const commonFields = new Map( - commonDoc.contents.items.map(field => { + commonDoc.get('body').items.map(field => { field.commentBefore = ' This field is managed by .common.yaml'; return [field.get('id'), field]; }),