Skip to content

Commit db20abf

Browse files
authored
🏗 Enable VSCode auto-formatting and prettier checks for .yml files (ampproject#34478)
1 parent 38350b8 commit db20abf

12 files changed

+521
-536
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+55-55
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,59 @@
11
---
22
name: Bug Report
33
description: Report a bug in AMP.
4-
labels: "Type: Bug"
4+
labels: 'Type: Bug'
55
body:
6-
- type: markdown
7-
id: header
8-
attributes:
9-
value: |
10-
Thanks for filling out this bug report.
11-
- Bugs related to the [AMP](https://amp.dev) format and cache can be reported using the form below.
12-
- Bugs related to the [AMP WordPress Plugin](https://wordpress.org/plugins/amp/) can be reported at the [support forum](https://wordpress.org/support/plugin/amp/) or at the [`amp-wp`](https://github.com/ampproject/amp-wp/issues) repository.
13-
- Questions about AMP uage can be asked at the [`#using-amp`](https://amphtml.slack.com/archives/C9HPA6HGB) Slack channel or at the [`amp-html`](http://stackoverflow.com/questions/tagged/amp-html) tag at Stack Overflow.
14-
- Questions about Google Search can be asked at Google's [Help Community](https://goo.gl/utQ1KZ).
15-
- type: textarea
16-
id: description
17-
attributes:
18-
label: Description
19-
description: A brief description of the bug.
20-
placeholder: Describe the expected vs. the current behavior, so this issue can be directed to the correct working group for investigation.
21-
validations:
22-
required: true
23-
- type: textarea
24-
id: repro_steps
25-
attributes:
26-
label: Reproduction Steps
27-
description: Step-by-step instructions for reproducing the issue.
28-
placeholder: Provide a publicly accessible URL and a reduced set of steps that clearly demonstrate the issue.
29-
validations:
30-
required: true
31-
- type: textarea
32-
id: logs
33-
attributes:
34-
label: Relevant Logs
35-
description: Relevant logging output.
36-
placeholder: Paste any plain-text logs here (e.g. console warnings or errors from Chrome DevTools). They will automatically be formatted as code.
37-
render: shell
38-
- type: dropdown
39-
id: browsers
40-
attributes:
41-
label: Browser(s) Affected
42-
description: Select one or more browser(s).
43-
multiple: true
44-
options:
45-
- Chrome
46-
- Firefox
47-
- Safari
48-
- Edge
49-
- UC Browser
50-
validations:
51-
required: true
52-
- type: input
53-
id: version
54-
attributes:
55-
label: AMP Version Affected
56-
description: If applicable, indicate a version in the format YYMMDDHHMMXXX. Otherwise just put down 'latest'.
57-
placeholder: e.g. 2101280515000
58-
validations:
59-
required: true
6+
- type: markdown
7+
id: header
8+
attributes:
9+
value: |
10+
Thanks for filling out this bug report.
11+
- Bugs related to the [AMP](https://amp.dev) format and cache can be reported using the form below.
12+
- Bugs related to the [AMP WordPress Plugin](https://wordpress.org/plugins/amp/) can be reported at the [support forum](https://wordpress.org/support/plugin/amp/) or at the [`amp-wp`](https://github.com/ampproject/amp-wp/issues) repository.
13+
- Questions about AMP uage can be asked at the [`#using-amp`](https://amphtml.slack.com/archives/C9HPA6HGB) Slack channel or at the [`amp-html`](http://stackoverflow.com/questions/tagged/amp-html) tag at Stack Overflow.
14+
- Questions about Google Search can be asked at Google's [Help Community](https://goo.gl/utQ1KZ).
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Description
19+
description: A brief description of the bug.
20+
placeholder: Describe the expected vs. the current behavior, so this issue can be directed to the correct working group for investigation.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: repro_steps
25+
attributes:
26+
label: Reproduction Steps
27+
description: Step-by-step instructions for reproducing the issue.
28+
placeholder: Provide a publicly accessible URL and a reduced set of steps that clearly demonstrate the issue.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: logs
33+
attributes:
34+
label: Relevant Logs
35+
description: Relevant logging output.
36+
placeholder: Paste any plain-text logs here (e.g. console warnings or errors from Chrome DevTools). They will automatically be formatted as code.
37+
render: shell
38+
- type: dropdown
39+
id: browsers
40+
attributes:
41+
label: Browser(s) Affected
42+
description: Select one or more browser(s).
43+
multiple: true
44+
options:
45+
- Chrome
46+
- Firefox
47+
- Safari
48+
- Edge
49+
- UC Browser
50+
validations:
51+
required: true
52+
- type: input
53+
id: version
54+
attributes:
55+
label: AMP Version Affected
56+
description: If applicable, indicate a version in the format YYMMDDHHMMXXX. Otherwise just put down 'latest'.
57+
placeholder: e.g. 2101280515000
58+
validations:
59+
required: true
+128-121
Original file line numberDiff line numberDiff line change
@@ -1,127 +1,134 @@
11
---
22
name: Cherry-Pick Request
33
description: Request a cherry-pick to an AMP release.
4-
labels: ["Type: Release", "Cherry-pick: Beta", "Cherry-pick: Experimental", "Cherry-pick: LTS", "Cherry-pick: Stable"]
4+
labels:
5+
[
6+
'Type: Release',
7+
'Cherry-pick: Beta',
8+
'Cherry-pick: Experimental',
9+
'Cherry-pick: LTS',
10+
'Cherry-pick: Stable',
11+
]
512
title: "\U0001F338 Cherry-pick request for #ISSUE into #RELEASE"
613
body:
7-
- type: markdown
8-
id: header
9-
attributes:
10-
value: |
11-
Thanks for filling out this cherry-pick request.
12-
- See AMP's [release schedule](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md) to learn about how releases work.
13-
- See AMP's [release calendar](https://amp-release-calendar.appspot.com) for information about past releases (e.g. versions, dates, submission times, notes).
14-
- See AMP's [code contribution docs](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#Cherry-picks) for an overview of the cherry-pick process.
15-
- type: input
16-
id: issue
17-
attributes:
18-
label: Issue (P0 Bug)
19-
description: The P0 bug that necessitates this cherry-pick. Remember to update the issue title with this info.
20-
placeholder: "e.g. #11111"
21-
validations:
22-
required: true
23-
- type: input
24-
id: pull_request
25-
attributes:
26-
label: Pull Request(s)
27-
description: The PR(s) that fix the bug. Make sure they are merged and have passing [CI builds](https://app.circleci.com/pipelines/github/ampproject/amphtml?branch=main).
28-
placeholder: "e.g. #22222, #33333"
29-
validations:
30-
required: true
31-
- type: input
32-
id: release_tracker
33-
attributes:
34-
label: Release Tracker(s)
35-
description: The [tracker issue(s)](https://github.com/ampproject/amphtml/labels/Type%3A%20Release) for the release to which the cherry-pick will be applied. Remember to update the issue title with this info.
36-
placeholder: "e.g. #44444, #55555"
37-
validations:
38-
required: true
39-
- type: dropdown
40-
id: channels
41-
attributes:
42-
label: Channels
43-
description: The [release channels](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md#release-channels) to which the cherry-pick will be applied. Remember to update the issue labels with this info.
44-
multiple: true
45-
options:
46-
- Beta / Experimental
47-
- Stable
48-
- LTS
49-
validations:
50-
required: true
51-
- type: textarea
52-
id: justification
53-
attributes:
54-
label: Justification
55-
description: Why you believe this issue meets the [cherry-pick criteria](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#Cherry-picks).
56-
placeholder: Provide a specific rationale for why this fix cannot wait until the next Stable release.
57-
validations:
58-
required: true
59-
- type: textarea
60-
id: verification_steps
61-
attributes:
62-
label: Verification Steps
63-
description: How the fix can be verified once the cherry-pick has been performed.
64-
placeholder: Provide detailed steps to manually verify the changes in this cherry-pick. They will be run by a developer or a QA expert to ensure that the bug was indeed fixed.
65-
validations:
66-
required: true
67-
- type: markdown
68-
id: mini_postmortem
69-
attributes:
70-
value: |
71-
## Mini Postmortem
72-
For cherry-picks to Stable or LTS, the following sections serve as a postmortem, and are meant to document things like the bug summary, its root causes, user impact, and action items. Fill in these sections to the best of your knowledge so that similar issues can be prevented in future. For cherry-picks to only Beta / Experimental, these sections can be ignored.
73-
- type: textarea
74-
id: summary
75-
attributes:
76-
label: Summary
77-
description: A summary of the problem and its root cause(s).
78-
placeholder: |
79-
For Stable or LTS cherry-picks, provide answers to questions like:
80-
- What is the bug being fixed?
81-
- What are its root cause(s)?
82-
- Could it have been detected by error reports, error / performance graphs, or CI checks?
83-
If details are as yet unknown, put down "TODO" in this section and remember to fill it in later.
84-
- type: textarea
85-
id: impact
86-
attributes:
87-
label: Impact
88-
description: How users were impacted.
89-
placeholder: |
90-
For Stable or LTS cherry-picks, provide answers to questions like:
91-
- Which users were affected? E.g. Users of Firefox version XXX.
92-
- Roughly how many users? E.g. O(YYY) users.
93-
- How were they affected? E.g. ZZZ feature did not work.
94-
If details are as yet unknown, put down "TODO" in this section and remember to fill it in later.
95-
- type: textarea
96-
id: action_items
97-
attributes:
98-
label: Action Items
99-
description: What can be done to prevent this in future.
100-
placeholder: |
101-
For Stable or LTS cherry-picks, provide answers to questions like:
102-
- How can this class of bugs be prevented in the future?
103-
- How do we detect them sooner and mitigate their impact?
104-
- How could we make the investigation of these issues easier?
105-
If details are as yet unknown, put down "TODO" in this section and remember to fill it in later.
106-
- type: textarea
107-
id: cherry_pick_progress
108-
attributes:
109-
label: Cherry-Pick Progress
110-
description: Progress details for this cherry-pick.
111-
value: |
112-
<!-- Leave this section as it is for now. -->
14+
- type: markdown
15+
id: header
16+
attributes:
17+
value: |
18+
Thanks for filling out this cherry-pick request.
19+
- See AMP's [release schedule](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md) to learn about how releases work.
20+
- See AMP's [release calendar](https://amp-release-calendar.appspot.com) for information about past releases (e.g. versions, dates, submission times, notes).
21+
- See AMP's [code contribution docs](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#Cherry-picks) for an overview of the cherry-pick process.
22+
- type: input
23+
id: issue
24+
attributes:
25+
label: Issue (P0 Bug)
26+
description: The P0 bug that necessitates this cherry-pick. Remember to update the issue title with this info.
27+
placeholder: 'e.g. #11111'
28+
validations:
29+
required: true
30+
- type: input
31+
id: pull_request
32+
attributes:
33+
label: Pull Request(s)
34+
description: The PR(s) that fix the bug. Make sure they are merged and have passing [CI builds](https://app.circleci.com/pipelines/github/ampproject/amphtml?branch=main).
35+
placeholder: 'e.g. #22222, #33333'
36+
validations:
37+
required: true
38+
- type: input
39+
id: release_tracker
40+
attributes:
41+
label: Release Tracker(s)
42+
description: The [tracker issue(s)](https://github.com/ampproject/amphtml/labels/Type%3A%20Release) for the release to which the cherry-pick will be applied. Remember to update the issue title with this info.
43+
placeholder: 'e.g. #44444, #55555'
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: channels
48+
attributes:
49+
label: Channels
50+
description: The [release channels](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md#release-channels) to which the cherry-pick will be applied. Remember to update the issue labels with this info.
51+
multiple: true
52+
options:
53+
- Beta / Experimental
54+
- Stable
55+
- LTS
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: justification
60+
attributes:
61+
label: Justification
62+
description: Why you believe this issue meets the [cherry-pick criteria](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#Cherry-picks).
63+
placeholder: Provide a specific rationale for why this fix cannot wait until the next Stable release.
64+
validations:
65+
required: true
66+
- type: textarea
67+
id: verification_steps
68+
attributes:
69+
label: Verification Steps
70+
description: How the fix can be verified once the cherry-pick has been performed.
71+
placeholder: Provide detailed steps to manually verify the changes in this cherry-pick. They will be run by a developer or a QA expert to ensure that the bug was indeed fixed.
72+
validations:
73+
required: true
74+
- type: markdown
75+
id: mini_postmortem
76+
attributes:
77+
value: |
78+
## Mini Postmortem
79+
For cherry-picks to Stable or LTS, the following sections serve as a postmortem, and are meant to document things like the bug summary, its root causes, user impact, and action items. Fill in these sections to the best of your knowledge so that similar issues can be prevented in future. For cherry-picks to only Beta / Experimental, these sections can be ignored.
80+
- type: textarea
81+
id: summary
82+
attributes:
83+
label: Summary
84+
description: A summary of the problem and its root cause(s).
85+
placeholder: |
86+
For Stable or LTS cherry-picks, provide answers to questions like:
87+
- What is the bug being fixed?
88+
- What are its root cause(s)?
89+
- Could it have been detected by error reports, error / performance graphs, or CI checks?
90+
If details are as yet unknown, put down "TODO" in this section and remember to fill it in later.
91+
- type: textarea
92+
id: impact
93+
attributes:
94+
label: Impact
95+
description: How users were impacted.
96+
placeholder: |
97+
For Stable or LTS cherry-picks, provide answers to questions like:
98+
- Which users were affected? E.g. Users of Firefox version XXX.
99+
- Roughly how many users? E.g. O(YYY) users.
100+
- How were they affected? E.g. ZZZ feature did not work.
101+
If details are as yet unknown, put down "TODO" in this section and remember to fill it in later.
102+
- type: textarea
103+
id: action_items
104+
attributes:
105+
label: Action Items
106+
description: What can be done to prevent this in future.
107+
placeholder: |
108+
For Stable or LTS cherry-picks, provide answers to questions like:
109+
- How can this class of bugs be prevented in the future?
110+
- How do we detect them sooner and mitigate their impact?
111+
- How could we make the investigation of these issues easier?
112+
If details are as yet unknown, put down "TODO" in this section and remember to fill it in later.
113+
- type: textarea
114+
id: cherry_pick_progress
115+
attributes:
116+
label: Cherry-Pick Progress
117+
description: Progress details for this cherry-pick.
118+
value: |
119+
<!-- Leave this section as it is for now. -->
113120
114-
To be updated by @ampproject/release-on-duty as each stage is completed.
115-
- [x] Cherry-pick request created
116-
- [ ] Cherry-pick request approved
117-
- [ ] New version released to Beta / Experimental channels
118-
- [ ] New version released to Stable channel
119-
- [ ] New version released to LTS channel
120-
- [ ] Release tracker updated
121-
- [ ] Cherry-pick completed
122-
- type: textarea
123-
id: notifications
124-
attributes:
125-
label: Notifications
126-
description: Add working groups or individuals you want to notify about this cherry-pick.
127-
value: /cc @ampproject/release-on-duty @ampproject/wg-approvers @ampproject/cherry-pick-approvers
121+
To be updated by @ampproject/release-on-duty as each stage is completed.
122+
- [x] Cherry-pick request created
123+
- [ ] Cherry-pick request approved
124+
- [ ] New version released to Beta / Experimental channels
125+
- [ ] New version released to Stable channel
126+
- [ ] New version released to LTS channel
127+
- [ ] Release tracker updated
128+
- [ ] Cherry-pick completed
129+
- type: textarea
130+
id: notifications
131+
attributes:
132+
label: Notifications
133+
description: Add working groups or individuals you want to notify about this cherry-pick.
134+
value: /cc @ampproject/release-on-duty @ampproject/wg-approvers @ampproject/cherry-pick-approvers

0 commit comments

Comments
 (0)