Skip to content

Conversation

@kpj2006
Copy link
Contributor

@kpj2006 kpj2006 commented Jan 1, 2026

Addressed Issues:

Fixes #(issue number)

Screenshots/Recordings:

Additional Notes:

Checklist

  • [ x] My code follows the project's code style and conventions
  • [ x] I have made corresponding changes to the documentation
  • [x ] My changes generate no new warnings or errors
  • [x ] I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • [ x] I have read the Contributing Guidelines

⚠️ AI Notice - Important!

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.

Summary by CodeRabbit

  • New Features
    • Automated workflow added to create initial issues from a template file
    • Issue templates (bug reports, feature requests, good first issues) now automatically labeled with "triage-needed" for improved organization

✏️ Tip: You can customize this high-level summary in your review settings.

kpj2006 and others added 8 commits December 30, 2025 08:49
Updated issue template for CI/CD to focus on deployment pipeline setup and removed obsolete testing tasks.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 1, 2026

📝 Walkthrough

Walkthrough

This pull request adds a "triage-needed" label to three issue templates, introduces a JSON file containing predefined issues with metadata, and creates a GitHub Actions workflow to automate issue creation from that JSON file, with cleanup upon completion.

Changes

Cohort / File(s) Summary
Issue Template Updates
​.github/ISSUE_TEMPLATE/bug_report.yml, feature_request.yml, good_first_issue.yml
Added "triage-needed" label to the labels array in each template. The feature_request.yml and good_first_issue.yml also corrected field naming and formatting in their label definitions.
Initial Issues Data
​.github/initial-issues.json
New file containing a structured array of predefined issues, each with title, body (description, tasks, resources), and optional labels array covering documentation, CI/CD, frontend, blockchain, backend, security, testing, performance, and database areas.
Issue Creation Workflow
​.github/workflows/create-initial-issues.yml
New GitHub Actions workflow that reads initial-issues.json, validates structure, creates each issue via GitHub API with per-issue logging, and upon success deletes the JSON file and workflow file itself, committing and pushing the cleanup. Includes concurrency control and repository guard conditions.

Sequence Diagram(s)

sequenceDiagram
    participant GHA as GitHub Actions
    participant Repo as Repository
    participant API as GitHub API
    participant Git as Git Operations

    GHA->>Repo: Checkout code (actions/checkout@v4)
    GHA->>Repo: Check if initial-issues.json exists
    alt File does not exist
        GHA->>GHA: Log skip message
    else File exists
        GHA->>Repo: Read initial-issues.json
        GHA->>GHA: Parse & validate JSON structure
        loop For each issue in array
            GHA->>API: Create issue with title, body, labels
            API-->>GHA: Issue created
            GHA->>GHA: Log issue result
        end
        GHA->>GHA: Aggregate success/failure summary
        alt All issues created successfully
            GHA->>Repo: Delete initial-issues.json
            GHA->>Repo: Delete create-initial-issues.yml workflow
            GHA->>Git: Stage deletions
            GHA->>Git: Commit cleanup changes
            GHA->>Git: Rebase & push to branch
        else Any creation failed
            GHA->>GHA: Fail workflow step
        end
    end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

  • pre-issue #15: Directly related—both PRs modify the same automation files (.github/workflows/create-initial-issues.yml and .github/initial-issues.json).
  • add issue template #3: Directly related—updates the same issue template files (bug_report.yml, feature_request.yml, good_first_issue.yml) by adding "triage-needed" labels.

Suggested labels

documentation, configuration, github-actions, no-issue-linked, size/L

Suggested reviewers

  • Zahnentferner

Poem

🐰 Hop, hop! The labels now align,
Triage-needed marks each line,
JSON issues, ready to spawn,
Workflows dance from dusk to dawn!
Templates clean, automation's gain—
Repository magic, plain and plain!

Pre-merge checks

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Add triage' is vague and generic, using non-descriptive language that doesn't convey meaningful information about the substantial changes made to issue templates and workflows. Use a more specific title such as 'Add triage-needed label to issue templates and create initial issues workflow' to better describe the main changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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 and usage tips.

@github-actions github-actions bot added size/M and removed size/L labels Jan 1, 2026
@github-actions github-actions bot added size/XS and removed size/M labels Jan 1, 2026
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (3)
.github/initial-issues.json (2)

1-11: Consider adding triage-needed label for consistency.

The issue templates (bug_report.yml, feature_request.yml, good_first_issue.yml) now include the triage-needed label, but issues created from this JSON file will not have it. If this is intentional (pre-triaged issues don't need triage), this is fine. Otherwise, consider adding "triage-needed" to each issue's labels array for a consistent workflow.


76-85: Minor: Unnecessary blank line in JSON array.

Line 76 contains an empty line within the array. While valid JSON, it's slightly inconsistent with the formatting of other entries.

.github/workflows/create-initial-issues.yml (1)

58-73: Consider adding rate limiting for bulk issue creation.

Creating 27 issues in rapid succession may hit GitHub's secondary rate limits. Consider adding a small delay between issue creations to avoid throttling.

🔎 Proposed fix
             // Create each issue
             for (const issue of issuesData.issues) {
               try {
                 const response = await github.rest.issues.create({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   title: issue.title,
                   body: issue.body,
                   labels: issue.labels || []
                 });
                 console.log(`✓ Created issue #${response.data.number}: ${issue.title}`);
                 successCount++;
+                // Small delay to avoid hitting secondary rate limits
+                await new Promise(resolve => setTimeout(resolve, 1000));
               } catch (error) {
                 console.error(`✗ Failed to create issue "${issue.title}":`, error.message);
                 failCount++;
               }
             }
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 81c305f and 8e93df4.

📒 Files selected for processing (5)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/ISSUE_TEMPLATE/good_first_issue.yml
  • .github/initial-issues.json
  • .github/workflows/create-initial-issues.yml
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-25T01:19:20.143Z
Learnt from: kpj2006
Repo: AOSSIE-Org/Template-Repo PR: 4
File: .github/workflows/release-drafter.yml:4-7
Timestamp: 2025-12-25T01:19:20.143Z
Learning: In the Template-Repo (AOSSIE-Org/Template-Repo), the release-drafter workflow intentionally includes both `main` and `master` branches in the trigger configuration because it's a template repository that needs to support projects using either branch naming convention.

Applied to files:

  • .github/workflows/create-initial-issues.yml
🔇 Additional comments (5)
.github/ISSUE_TEMPLATE/bug_report.yml (1)

4-4: LGTM!

The addition of the triage-needed label is correctly formatted. Ensure the triage-needed label exists in the repository settings, or it will be auto-created when the first issue is filed using this template.

.github/ISSUE_TEMPLATE/good_first_issue.yml (1)

4-4: LGTM!

Consistent with the other template updates to include the triage-needed label.

.github/ISSUE_TEMPLATE/feature_request.yml (1)

4-4: LGTM!

Consistent with the other template updates.

.github/workflows/create-initial-issues.yml (2)

3-8: Workflow triggers on both main and master branches.

This is appropriate for a template repository that needs to support projects using either branch naming convention. Based on learnings from this repository, this dual-branch pattern is intentional.


13-16: Concurrency and conditional logic look good.

The concurrency group with cancel-in-progress: false ensures sequential execution, and the condition correctly prevents the workflow from running on the template repo itself while restricting it to AOSSIE-Org repositories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant