Skip to content

fix(ci): add changeset-check job to PR checks#28

Open
gSimani wants to merge 3 commits intomainfrom
fix/add-changeset-check
Open

fix(ci): add changeset-check job to PR checks#28
gSimani wants to merge 3 commits intomainfrom
fix/add-changeset-check

Conversation

@gSimani
Copy link
Copy Markdown
Owner

@gSimani gSimani commented Nov 6, 2025

Adds the changeset-check job to the PR checks workflow to enforce that code changes include a changeset file. This ensures proper version tracking and changelog generation.

Summary by Sourcery

Add a GitHub Actions job to enforce that code changes include a .changeset file and update documentation with a complete scraper fixes report

CI:

  • Add a changeset-check job to the PR checks workflow that fails if code-related paths change without an accompanying .changeset file

Documentation:

  • Add SCRAPER_FIXES_COMPLETE_REPORT.md outlining investigation findings, applied fixes, pending tasks, and next steps for scraper systems

Chores:

  • Add .changeset/add-changeset-check.md metadata to record the new changeset-check job

- Documents all 4 root causes and 3 fixes applied
- Includes testing results and verification steps
- Provides manual verification checklist for GitHub secrets
- Details Sunbiz system completion requirements
- Adds emergency recovery procedures
- Tracks implementation timeline and metrics
@railway-app
Copy link
Copy Markdown

railway-app bot commented Nov 6, 2025

🚅 Deployed to the ConcordBroker-pr-28 environment in ConcordBroker-Railway

Service Status Web Updated (UTC)
ConcordBroker ❌ Build Failed (View Logs) Nov 6, 2025 at 4:42 pm
observant-purpose ❌ Build Failed (View Logs) Web Nov 6, 2025 at 4:42 pm

@vercel
Copy link
Copy Markdown

vercel bot commented Nov 6, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
concord-broker Error Error Nov 6, 2025 4:42pm

@supabase
Copy link
Copy Markdown

supabase bot commented Nov 6, 2025

This pull request has been ignored for the connected project pmispwtdngkcmsrsjwbp because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Nov 6, 2025

Reviewer's Guide

This PR adds a new CI job to enforce that code changes include a changeset file, provides the corresponding .changeset patch entry, and introduces a comprehensive scraper fixes report document.

Flow diagram for changeset-check job logic

flowchart TD
  A["Start changeset-check job"]
  B["Checkout code"]
  C["Get base and head commit SHAs"]
  D["List changed files"]
  E["Are code-related paths changed?"]
  F["Check for .changeset/*.md file"]
  G["Pass job"]
  H["Fail job with error"]

  A --> B --> C --> D --> E
  E -- Yes --> F
  F -- Found --> G
  F -- Not found --> H
  E -- No --> G
Loading

File-Level Changes

Change Details Files
Add a new CI job to enforce changeset presence on code modifications
  • Define a changeset-check job in the PR checks workflow
  • Use actions/checkout with fetch-depth=0 to get full history
  • Compute diff between base and head commits and echo changed files
  • Require a .changeset/*.md file on code path changes or fail the job
  • Skip the check when no monitored code paths have changed
.github/workflows/pr-checks.yml
Add a patch-level changeset entry for the CI change
  • Create .changeset/add-changeset-check.md
  • Set the patch bump for the concordbroker package
  • Document the addition of the changeset-check job
.changeset/add-changeset-check.md
Introduce a detailed scraper fixes implementation report
  • Add a complete SCRAPER_FIXES_COMPLETE_REPORT.md
  • Include executive summary, completed fixes, pending items, and next steps
  • Capture testing checklist, manual verification, metrics, and root cause analysis
SCRAPER_FIXES_COMPLETE_REPORT.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • The huge SCRAPER_FIXES_COMPLETE_REPORT.md addition seems unrelated to the CI check and should be moved to a separate PR or docs directory to keep this change focused.
  • Consider using the official changesets/action GitHub Action instead of a custom bash diff to make the changeset check more maintainable and robust.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The huge SCRAPER_FIXES_COMPLETE_REPORT.md addition seems unrelated to the CI check and should be moved to a separate PR or docs directory to keep this change focused.
- Consider using the official changesets/action GitHub Action instead of a custom bash diff to make the changeset check more maintainable and robust.

## Individual Comments

### Comment 1
<location> `.github/workflows/pr-checks.yml:25-28` </location>
<code_context>
+          CHANGED=$(git diff --name-only "$BASE_SHA".."$HEAD_SHA")
+          echo "$CHANGED" | sed 's/^/ - /'
+          # If code-related paths changed, require a changeset file
+          if echo "$CHANGED" | grep -E '^(apps/|scripts/|mcp-server/|package\.json|apps/web/|apps/langchain_system/)'; then
+            if ls .changeset/*.md >/dev/null 2>&1; then
+              echo "Changeset found"
</code_context>

<issue_to_address>
**suggestion (bug_risk):** The grep pattern may miss changes in nested files or directories.

The pattern only matches top-level files. Update it to match nested files as well, such as by using a recursive pattern or a more robust method.

```suggestion
          # If code-related paths changed, require a changeset file
          if echo "$CHANGED" | grep -E '^(apps/|scripts/|mcp-server/|package\.json|apps/web/|apps/langchain_system/)' >/dev/null || \
             echo "$CHANGED" | grep -E '^(apps/|scripts/|mcp-server/|apps/web/|apps/langchain_system/)[^/]+/.+' >/dev/null; then
            if ls .changeset/*.md >/dev/null 2>&1; then
              echo "Changeset found"
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +25 to +28
# If code-related paths changed, require a changeset file
if echo "$CHANGED" | grep -E '^(apps/|scripts/|mcp-server/|package\.json|apps/web/|apps/langchain_system/)'; then
if ls .changeset/*.md >/dev/null 2>&1; then
echo "Changeset found"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

suggestion (bug_risk): The grep pattern may miss changes in nested files or directories.

The pattern only matches top-level files. Update it to match nested files as well, such as by using a recursive pattern or a more robust method.

Suggested change
# If code-related paths changed, require a changeset file
if echo "$CHANGED" | grep -E '^(apps/|scripts/|mcp-server/|package\.json|apps/web/|apps/langchain_system/)'; then
if ls .changeset/*.md >/dev/null 2>&1; then
echo "Changeset found"
# If code-related paths changed, require a changeset file
if echo "$CHANGED" | grep -E '^(apps/|scripts/|mcp-server/|package\.json|apps/web/|apps/langchain_system/)' >/dev/null || \
echo "$CHANGED" | grep -E '^(apps/|scripts/|mcp-server/|apps/web/|apps/langchain_system/)[^/]+/.+' >/dev/null; then
if ls .changeset/*.md >/dev/null 2>&1; then
echo "Changeset found"

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