Skip to content

feat: Issue Type & Metadata Automation Project#1179

Closed
ashleyshaw wants to merge 3 commits into
developfrom
research/issue-type-workflow-audit
Closed

feat: Issue Type & Metadata Automation Project#1179
ashleyshaw wants to merge 3 commits into
developfrom
research/issue-type-workflow-audit

Conversation

@ashleyshaw

Copy link
Copy Markdown
Member

Summary

Comprehensive issue-type workflow automation project with audit, design, and 12 implementation issues.

What's Included

Project Setup

Documentation

  • ✅ audit-2026-07-23-comprehensive.md (5 critical + 5 major issues identified)
  • ✅ solution-design-2026-07-23.md (detailed architecture for 3-phase fix)
  • ✅ PROJECT_INDEX.md, README.md, IMPLEMENTATION_PLAN.md, ISSUES_INDEX.md
  • ✅ 12 issue markdown files (epic + 11 tasks)

Issues Created

Test Plan

Next Steps

  1. Merge this PR to develop
  2. Review epic issue: Epic: Issue Type & Metadata Automation Initiative #1167
  3. Assign Phase 1 engineer(s)
  4. Begin implementation week of July 24

🤖 Generated with Claude Code

ashleyshaw and others added 3 commits July 23, 2026 16:18
Add comprehensive planning documentation for bulk project creation system with
template-driven field initialization. Includes:

- INDEX.md: Project overview and navigation
- PLANNING.md: Full architectural blueprint with field mappings, CSV schema,
  agent and workflow design, implementation roadmap
- SUMMARY.md: Quick overview and GitHub issue creation guide
- ISSUES.md: Copy-paste ready Epic and Story issue templates

Two template types planned:
1. Client Delivery (Scrumban + UAT): Status Backlog→Todo→Done, 9 views
2. Product Development (Release Train): Status Backlog→Ready→Done, 8 views

Shared fields across both templates (14 core): Priority, Type, Effort, Area,
Theme, Size, Dates, Milestone, Environment, Parent Issue, Sub-issues
Progress, Time

Implementation: 4 phases, 3–4 weeks, 4–5 developers
- Phase 1: Foundations (CSV schema, agent scaffold, workflow)
- Phase 2: Client Delivery template (1–2 weeks, parallel)
- Phase 3: Product Development template (1–2 weeks, parallel)
- Phase 4: PR Type syncing + docs (1 week)

Depends on: #1145 (org issue-field writer), #1146 (secret-gating)

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
## Summary

Audit identifies critical gaps in issue type automation:

- Issue types not auto-assigned from templates (25 templates, 0 automation)
- GitHub bot silently reopens incomplete issues without clear guidance
- DoD enforcement missing for issues (only PRs validated)
- 109 labels unprotected by governance policy
- Type label aliases incomplete (feature label removed, bug preserved)
- PR merges not blocked if linked issue has incomplete DoD
- Custom field population undocumented

All issues are fixable with targeted workflow changes. Solution design includes:
- 5 critical fixes (1.1-1.5)
- 3 new validation workflows (2.1-2.3)
- 40+ issue-based labeling rules
- 7 custom field auto-population rules
- AI agent guidance documentation

## Reports

- audit-2026-07-23-comprehensive.md: Full findings (critical, major, minor issues with detailed analysis)
- solution-design-2026-07-23.md: Implementation architecture & phased rollout plan (37.5 hrs, 5 weeks)

## Next Steps

1. Review audit & design documents
2. Approve phased implementation approach
3. Begin Phase 1: Critical fixes (weeks 1-2)
   - Remove non-existent label reference
   - Add missing type aliases
   - Implement issue-based labeling rules
   - Fix template-enforcement reopening
   - Add issue DoD validation

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
…entation plan

## Summary

Create active project folder with:
- Complete implementation plan (37.5 hours, 5 weeks, 3 phases)
- 12 issue markdown files (1 epic + 11 child issues)
- Project index, README, and issues index
- Detailed step-by-step implementation guides for each task

## Project Structure

**Phase 1: Critical Fixes (11.5h, Weeks 1-2)**
- Fix 1.1: Remove non-existent label reference
- Fix 1.2: Add missing type label aliases
- Fix 1.3: Implement issue-body labeling rules (40+ patterns)
- Fix 1.4: Fix template-enforcement silent reopening
- Fix 1.5: Add issue DoD validation

**Phase 2: Enhanced Automation (15h, Weeks 3-4)**
- Feature 2.1: PR merge blocker (check linked issue DoD)
- Feature 2.2: Auto-populate custom fields
- Feature 2.3: Template-aware type detection

**Phase 3: Documentation & Testing (11h, Weeks 4-5)**
- Task 3.1: Create AI agent guidance document
- Task 3.2: Update AGENTS.md
- Task 3.3: End-to-end testing & validation

## Files Included

- PROJECT_INDEX.md (project overview & timeline)
- README.md (quick start by role)
- IMPLEMENTATION_PLAN.md (detailed roadmap & architecture)
- ISSUES_INDEX.md (complete issue listing)
- 12 markdown issue files (full task breakdowns)

## Next Steps

1. Create GitHub issues (epic + 11 child) via gh CLI or GitHub web UI
2. Set up GitHub Project board
3. Assign Phase 1 team members
4. Begin execution July 24

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

🚫 This PR description is missing required template content.

Missing required section(s): Linked issues, Changelog, Global DoD checklist

Please update the PR body using one of the repository PR templates:

Empty placeholders, unchecked checklist boxes, and stub issue references do not count.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@ashleyshaw, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 35 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 9eb560f8-1683-46a5-9e32-84628956ee7f

📥 Commits

Reviewing files that changed from the base of the PR and between c5246bb and f90af18.

📒 Files selected for processing (22)
  • .github/projects/active/github-projects-creation-system/INDEX.md
  • .github/projects/active/github-projects-creation-system/ISSUES.md
  • .github/projects/active/github-projects-creation-system/PLANNING.md
  • .github/projects/active/github-projects-creation-system/SUMMARY.md
  • .github/projects/active/issue-type-workflow-automation/IMPLEMENTATION_PLAN.md
  • .github/projects/active/issue-type-workflow-automation/ISSUES_INDEX.md
  • .github/projects/active/issue-type-workflow-automation/PROJECT_INDEX.md
  • .github/projects/active/issue-type-workflow-automation/README.md
  • .github/projects/active/issue-type-workflow-automation/issues/01-epic-issue-type-automation.md
  • .github/projects/active/issue-type-workflow-automation/issues/02-fix-nonexistent-label.md
  • .github/projects/active/issue-type-workflow-automation/issues/03-fix-type-aliases.md
  • .github/projects/active/issue-type-workflow-automation/issues/04-issue-body-labeling-rules.md
  • .github/projects/active/issue-type-workflow-automation/issues/05-fix-template-enforcement.md
  • .github/projects/active/issue-type-workflow-automation/issues/06-issue-dod-validation.md
  • .github/projects/active/issue-type-workflow-automation/issues/07-pr-merge-blocker.md
  • .github/projects/active/issue-type-workflow-automation/issues/08-custom-field-population.md
  • .github/projects/active/issue-type-workflow-automation/issues/09-template-aware-type.md
  • .github/projects/active/issue-type-workflow-automation/issues/10-ai-agent-guidance.md
  • .github/projects/active/issue-type-workflow-automation/issues/11-update-agents-md.md
  • .github/projects/active/issue-type-workflow-automation/issues/12-test-and-validate.md
  • .github/reports/issue-management/audit-2026-07-23-comprehensive.md
  • .github/reports/issue-management/solution-design-2026-07-23.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch research/issue-type-workflow-audit

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

⏱️ Aging and SLA annotation

  • Age: 0 day(s)
  • SLA state: Within SLA
  • Thresholds: warn at 7 days, breach at 14 days
  • Last updated: 2026-07-23T15:57:39.099Z

Maintained by project-meta-sync workflow.

@github-actions github-actions Bot added this to the v1.0 milestone Jul 23, 2026
@github-actions github-actions Bot added status:needs-review Awaiting code review priority:normal Default priority type:chore Chore / small hygiene change type:bug Bug or defect meta:needs-changelog Requires a changelog entry before merge labels Jul 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #1179

CI Status:success
Files changed: 22
Risk Distribution: 0 critical, 22 high, 0 medium, 0 low

Recommendations

  • Ready to proceed pending human review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f90af18352

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +195 to +197
**File:** `.github/labeler.yml`
**Problem:** No automation for issue template → type label mapping
**Solution:** Add `issues:` section with 40+ body-pattern rules

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Extend the parser before adding issue rules

When Fix 1.3 is implemented as written, the new issues: array will not apply any labels: scripts/agents/includes/labeler-utils.js treats each top-level key as the label name and only evaluates head-branch and changed-files, while scripts/validation/validate-labeling-configs.cjs rejects array-valued rules. Include the required parser, schema, and runtime changes in this task, or define the body patterns in a format the existing agent supports.

Useful? React with 👍 / 👎.

Comment on lines +265 to +268
- POST detailed comment explaining what's missing
- ADD label `status:needs-template-fix`
- DO NOT REOPEN (let user decide)
- Add `meta:force-close` escape hatch

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Define the workflow labels before using them

When this close-guard change is implemented, neither status:needs-template-fix nor meta:force-close exists in the reviewed .github/labels.yml, and the plan's labels task only adds aliases rather than defining them. Adding the status label will therefore fail, and users cannot activate the documented escape hatch; add these labels to the canonical registry or use existing canonical labels such as status:needs-more-info.

Useful? React with 👍 / 👎.

Comment on lines +410 to +411
// 1. Check if issue body contains template signature
const templateMatch = issue.body?.match(/Created from:\s+(.+?)\.md/);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Add a real template signal before matching it

For issues opened from any of the 25 current Markdown templates, this branch never runs: a repository-wide check of .github/ISSUE_TEMPLATE/*.md found no Created from: marker, and GitHub does not add this proposed text to the issue body automatically. The feature will always fall back to the existing keyword heuristic, so either add a durable signature to every template and map the actual filenames or derive the type from signals that already exist.

Useful? React with 👍 / 👎.

Comment on lines +431 to +433
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Re-run the merge guard when its inputs change

If a PR body is edited after this check succeeds, a contributor can add or replace a closing reference with an incomplete issue without triggering another run because edited is absent; similarly, editing the linked issue's DoD does not trigger this PR workflow. The previously successful required check can therefore remain green even though the current linked issue is incomplete, so the design needs triggers or another mechanism that revalidates whenever either input changes.

Useful? React with 👍 / 👎.

- [ ] Check for false positives (ambiguous words)
- [ ] All 15 tests pass with expected labels

## Definition of Done (DoD)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add the mandatory sections to every issue draft

When these files are used as the advertised GitHub issue drafts, 04-issue-body-labeling-rules.md lacks a DoR section and drafts 05–12 lack both DoR and DoD sections, so the existing template-enforcement workflow will immediately flag the resulting implementation issues with status:needs-more-info. Add both required sections to every draft before treating them as ready to create.

AGENTS.md reference: AGENTS.md:L193-L199

Useful? React with 👍 / 👎.

Comment on lines +37 to +38
| [WORK-BREAKDOWN.md](./WORK-BREAKDOWN.md) | Task breakdown, effort, timeline (12 KB) | Project managers, developers |
| [TEMPLATE-COMPARISON.md](./TEMPLATE-COMPARISON.md) | Visual template comparison (12 KB) | All stakeholders |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restore the documents linked from the project index

At the reviewed commit, a complete git ls-tree -r check shows that neither WORK-BREAKDOWN.md nor TEMPLATE-COMPARISON.md exists, although this index and SUMMARY.md direct implementers to both documents for execution details. These links therefore return 404s and leave the advertised work breakdown and comparison unavailable; add the files or remove and replace the references.

Useful? React with 👍 / 👎.

@ashleyshaw ashleyshaw closed this Jul 23, 2026
@ashleyshaw
ashleyshaw deleted the research/issue-type-workflow-audit branch July 23, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

meta:needs-changelog Requires a changelog entry before merge priority:normal Default priority status:needs-review Awaiting code review type:bug Bug or defect type:chore Chore / small hygiene change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant