Skip to content

docs: open source GitHub repos require Status checks enabled for analysis TAROT-3701#2642

Merged
claudiacodacy merged 5 commits intomasterfrom
github-updates-review
Apr 24, 2026
Merged

docs: open source GitHub repos require Status checks enabled for analysis TAROT-3701#2642
claudiacodacy merged 5 commits intomasterfrom
github-updates-review

Conversation

@claudiacodacy
Copy link
Copy Markdown
Contributor

Summary

  • Added an !!! important admonition to the Status checks section of the GitHub integration page, noting that open source repositories on GitHub will not be analyzed if Status checks is disabled.
  • Expanded the troubleshooting FAQ ("Why isn't my public repository being analyzed?") to list both conditions required for analysis to run on open source GitHub repos: admin must be a committer, and Status checks must be enabled.

Test plan

  • Verify mkdocs build completes without errors
  • Confirm internal links to github-integration.md#status-checks and default-git-provider-integration-settings.md resolve correctly

🤖 Generated with Claude Code

claudiacodacy and others added 2 commits March 3, 2026 13:46
…abled for analysis

For open source repositories on GitHub, Codacy no longer runs analysis when the Status checks integration setting is disabled. Added a warning to the GitHub integration page and expanded the troubleshooting FAQ to include this as a reason analysis may not run.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claudiacodacy claudiacodacy requested a review from a team as a code owner April 24, 2026 10:35
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

Overall readability score: 54.18 (🟢 +0.04)

File Readability
github-integration.md 50.31 (🟢 +0.11)
why-isnt-my-public-repository-being-analyzed.md 38.56 (🟢 +9.56)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
github-integration.md 50.31 34.86 11.64 13.2 12.65 7.83
  🟢 +0.11 🔴 -0.21 🟢 +0.02 🔴 -0.1 🟢 +0 🟢 +0.08
why-isnt-my-public-repository-being-analyzed.md 38.56 13.65 13.99 12.4 13.68 9.05
  🟢 +9.56 🟢 +11.21 🟢 +4.32 🔴 -0.2 🔴 -1.27 🟢 +0.74

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.18 43.07 10.92 12.32 12.24 8.01
  🟢 +0.04 🟢 +0.04 🟢 +0.02 🟢 +0 🔴 -0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions github-actions Bot temporarily deployed to Netlify April 24, 2026 10:37 Inactive
@codacy-production
Copy link
Copy Markdown
Contributor

codacy-production Bot commented Apr 24, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

Copy link
Copy Markdown
Contributor

@codacy-production codacy-production Bot left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

While this PR successfully documents the new requirement for Status checks on public GitHub repositories, it introduces significant undocumented changes to the March 2026 release notes and inadvertently narrows the scope of the troubleshooting FAQ.

Key issues to address:

  • Scope Creep: The release notes have been updated with new sections and a date shift (March 16 to 17) that are absent from the PR description.
  • Documentation Logic: The troubleshooting guide for public repositories was modified to be GitHub-specific, which may confuse users on other Git providers.
  • Consistency: Inconsistent internal anchors and mixed regional spellings (British vs. American English) were found in the release notes.

About this PR

  • The PR includes substantial updates to docs/release-notes/cloud/cloud-2026-03-github-integration-settings-changes.md, including shifting the AI-enhanced comments deprecation date from March 16 to March 17 and adding a 'Why this change' section. These are not mentioned in the PR title or description. Please ensure the PR description reflects the full scope of the changes or separate unrelated documentation updates into a different PR.

Test suggestions

  • Verify the 'important' admonition text in docs/repositories-configure/integrations/github-integration.md accurately reflects the requirement.
  • Verify the troubleshooting FAQ lists both conditions (admin as committer and Status checks enabled).
  • Ensure internal links in the updated FAQ resolve to the correct relative paths for integration settings and organization defaults.
  • Run mkdocs build to ensure no broken links or rendering issues were introduced by the anchor changes or new sections.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Run `mkdocs build` to ensure no broken links or rendering issues were introduced by the anchor changes or new sections.

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

Comment thread docs/faq/troubleshooting/why-isnt-my-public-repository-being-analyzed.md Outdated
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to Netlify April 24, 2026 10:52 Inactive
…nalyzed.md

Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
@claudiacodacy claudiacodacy enabled auto-merge (squash) April 24, 2026 10:55
@github-actions github-actions Bot temporarily deployed to Netlify April 24, 2026 10:56 Inactive
@github-actions github-actions Bot temporarily deployed to Netlify April 24, 2026 11:31 Inactive
@claudiacodacy claudiacodacy merged commit 343e222 into master Apr 24, 2026
5 checks passed
@claudiacodacy claudiacodacy deleted the github-updates-review branch April 24, 2026 11:31
@lolgab lolgab changed the title docs: open source GitHub repos require Status checks enabled for analysis docs: open source GitHub repos require Status checks enabled for analysis TAROT-3791 Apr 24, 2026
@lolgab lolgab changed the title docs: open source GitHub repos require Status checks enabled for analysis TAROT-3791 docs: open source GitHub repos require Status checks enabled for analysis TAROT-3701 Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants