Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 19, 2025

Problem

The README.md file was displaying two problematic workflow status badges that showed "failing" status, creating confusion about the repository's health:

  1. A CI workflow badge that referenced a non-existent workflow
  2. A Label Checker badge that displayed "failing" despite the workflow functioning correctly

Additionally, the README contained outdated references to commitlint/conventional commits that are no longer used in the project.

Root Cause

Non-existent CI Badge

The README referenced a workflow named "CI" using the URL pattern:

![CI](https://github.com/OPCODE-Open-Spring-Fest/UniLoot/workflows/CI/badge.svg)

However, no such workflow exists in .github/workflows/. The repository only has:

  • checklabels.yaml (Label Checker)
  • prmerged.yaml (On Pull Request Merge)

Misleading Label Checker Badge

While the Label Checker workflow exists and functions correctly, its dynamic badge showed "failing" status because:

  • The workflow only runs on pull_request events, not on the main branch
  • The badge aggregates status across all open PRs
  • Any PR with missing labels causes the badge to show "failing", even though the workflow is working as designed
  • This created a misleading impression that the repository was in a failing state

Outdated Commitlint References

The README documented commitlint/conventional commits validation, but this has been removed from the project.

Solution

Removed Dynamic Workflow Badges

Removed both problematic badges and kept only the static informational badges:

  • ✅ MIT License
  • ✅ Contributions Welcome
  • ✅ Build Passing

These static badges provide accurate, consistent information without the confusion caused by dynamic workflow status badges.

Removed Commitlint Documentation

Per maintainer feedback, removed all commitlint references as it has been removed from the project:

  • Removed "Commit Message Validation" section
  • Updated Development section to use standard descriptive commit messages instead of conventional commits format
  • Updated Contributing section to remove conventional commits references
  • Changed commit message examples from feat:, fix:, docs: format to plain descriptive messages

Updated Documentation Structure

Before:

### CI/CD Workflows
This project has automated CI/CD workflows that run on every push and pull request:

#### 🔍 Commitlint (CI Workflow)
- **Runs on**: Every push and pull request

After:

### GitHub Actions Workflows
#### 🏷️ Label Checker
- **Runs on**: Pull request opened, edited, synchronized, reopened, labeled, or unlabeled events

Impact

  • ✅ README now accurately reflects repository status
  • ✅ No misleading "failing" badges
  • ✅ Removed outdated commitlint/conventional commits documentation
  • ✅ Only documents active workflows (Label Checker)
  • ✅ Contributors have accurate information about the automated checks
  • ✅ Commit message examples reflect current project standards

Testing

Verified that:

  • The Label Checker workflow runs successfully on PRs with proper labels
  • The documentation accurately describes only active validation mechanisms
  • Static badges display correctly
  • All commitlint references have been removed

Fixes #44

Original prompt

in the readme.md of this repo why the CI label and label checker label is showing failing bcz i think in reality its passing check and do the necessary changes


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI self-assigned this Oct 19, 2025
Copilot AI changed the title [WIP] Fix CI label and label checker failures in README docs: fix misleading CI and Label Checker badge status in README Oct 19, 2025
Copilot finished work on behalf of 04shubham7 October 19, 2025 10:25
Copilot AI requested a review from 04shubham7 October 19, 2025 10:25
@04shubham7 04shubham7 marked this pull request as ready for review October 19, 2025 10:42
Copy link
Member

@04shubham7 04shubham7 left a comment

Choose a reason for hiding this comment

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

no need of commitlint as i removed it completely from my project only label checker is there

README.md Outdated
This project has automated CI/CD workflows that run on every push and pull request:

#### 🔍 Commitlint (CI Workflow)
#### 🔍 Commitlint (Local Git Hooks)
Copy link
Member

Choose a reason for hiding this comment

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

remove commitlint as i have removed this workflow file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed the commitlint section and all related references. The README now only documents the Label Checker workflow. Commit: ec254b6 (updated)

@04shubham7
Copy link
Member

@copilot work on the requested changes

Copy link
Contributor Author

Copilot AI commented Oct 19, 2025

no need of commitlint as i removed it completely from my project only label checker is there

Removed all commitlint references from README including the Commit Message Validation section, Development section examples, and Contributing guidelines. Commit: ec254b6 (updated)

Copilot AI changed the title docs: fix misleading CI and Label Checker badge status in README docs: fix misleading CI and Label Checker badge status and remove commitlint references from README Oct 19, 2025
Copilot finished work on behalf of 04shubham7 October 19, 2025 10:49
Copilot AI requested a review from 04shubham7 October 19, 2025 10:49
Copy link
Member

@04shubham7 04shubham7 left a comment

Choose a reason for hiding this comment

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

Loooks nice

@04shubham7 04shubham7 merged commit d280677 into main Oct 19, 2025
4 checks passed
@04shubham7 04shubham7 deleted the copilot/fix-ci-label-checker-failure branch October 19, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants