Skip to content

Commit 6c02c5a

Browse files
committed
Remove example issue documentation and implementation summary for automatic CI failure issue creation
1 parent 3f1ce2e commit 6c02c5a

File tree

5 files changed

+215
-418
lines changed

5 files changed

+215
-418
lines changed

.github/workflows/EXAMPLE_ISSUE.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

.github/workflows/IMPLEMENTATION_SUMMARY.md

Lines changed: 0 additions & 197 deletions
This file was deleted.

.github/workflows/README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,36 +23,28 @@ When any job in the build workflow fails on the `main` branch, the `report-failu
2323
- Labels: `ci-failure`, `bug`, `needs-triage`
2424

2525
2. **Prevents duplicate issues** by:
26-
- Checking for existing open issues with the `ci-failure` label
27-
- Adding a comment to recent issues (within 24 hours) instead of creating duplicates
26+
- Checking for any existing open issues with the `ci-failure` label
27+
- Updating a single rolling "CI Failure Log" comment on the existing issue (edits in-place to reduce notification noise)
2828

2929
3. **Provides actionable information** including:
3030
- Workflow run URL for detailed logs
3131
- Commit details for quick identification
3232
- Author mention for notification
3333

34-
**Example Issue Title:**
35-
```
36-
CI Failure on main: lint, tests
37-
```
34+
**Example issue title:** `CI Failure on main: lint, tests`
3835

39-
**Example Issue Body:**
36+
**Example issue body (abbreviated):**
4037
```markdown
4138
## CI Failure Report
4239

4340
The following jobs failed on the main branch:
4441
- **lint**
4542
- **tests**
4643

47-
**Workflow Run:** https://github.com/microsoft/vscode-python/actions/runs/123456789
48-
**Commit:** abc123def456
49-
**Commit Message:** Fix test flakiness
50-
**Author:** @username
51-
52-
Please investigate and fix the failure.
53-
54-
---
55-
*This issue was automatically created by the CI system.*
44+
**Workflow Run:** <link>
45+
**Commit:** <sha>
46+
**Commit Message:** <message>
47+
**Author:** @<user>
5648
```
5749

5850
#### Configuration
@@ -63,6 +55,10 @@ The automatic issue filing is controlled by:
6355
- **Permissions:** Requires `issues: write` permission
6456
- **Dependencies:** Runs after all test jobs complete using `needs` and `always()`
6557

58+
#### Local validation
59+
60+
The issue filing logic is validated by the script in `.github/workflows/test-issue-creation.js`.
61+
6662
### pr-check.yml
6763
Runs on pull requests and non-main branches. Similar to build.yml but does not include automatic issue filing.
6864

0 commit comments

Comments
 (0)