Skip to content

feat: update sponsors script and how this works for more consistency#10582

Merged
jasonsaayman merged 1 commit intov1.xfrom
feat/improve-sponsors-run
Mar 30, 2026
Merged

feat: update sponsors script and how this works for more consistency#10582
jasonsaayman merged 1 commit intov1.xfrom
feat/improve-sponsors-run

Conversation

@jasonsaayman
Copy link
Copy Markdown
Member

@jasonsaayman jasonsaayman commented Mar 30, 2026

Summary by cubic

Make the sponsors update more consistent by using a single script and only creating PRs when the tracked README.md actually changes. This reduces noisy automated PRs and simplifies the workflow.

Description

  • Summary of changes
    • Workflow now calls scripts/sponsors/update-readme-sponsors.mjs and gates all follow-up steps on changed and readme_changed.
    • Adds a step to set readme_changed using git diff --quiet -- README.md.
    • Script refactor: writes changed via GITHUB_OUTPUT, removes shell exec and colorized logs, updates axios import path, and writes ./temp/sponsors.md.
    • .gitignore: adds openspec/.
  • Reasoning
    • Avoids PRs when README has no tracked changes.
    • Makes CI behavior predictable and reduces flaky shell interactions.
    • Standardizes logging and outputs for GitHub Actions.
  • Additional context
    • Requires marker <!--<div>marker</div>--> in README.md for injection.
    • PRs are created by peter-evans/create-pull-request@v8 only when both flags are true.

Docs

  • Update references from ./bin/sponsors.js to scripts/sponsors/update-readme-sponsors.mjs.
  • Local run: node scripts/sponsors/update-readme-sponsors.mjs (marker required; writes to ./temp/sponsors.md; GITHUB_OUTPUT not required locally).

Testing

  • No tests added.
  • Suggested: small unit tests for updateReadmeSponsors (marker present/missing, changed vs up-to-date). CI behavior can be verified by a workflow run where README doesn’t change to ensure the PR step is skipped.

Written for commit 54e7556. Summary will update on new commits.

@jasonsaayman jasonsaayman self-assigned this Mar 30, 2026
@jasonsaayman jasonsaayman added priority::medium A medium priority commit::feat The PR is related to a feature labels Mar 30, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-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.

No issues found across 3 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

@jasonsaayman jasonsaayman merged commit 4950ff6 into v1.x Mar 30, 2026
20 checks passed
@jasonsaayman jasonsaayman deleted the feat/improve-sponsors-run branch March 30, 2026 10:53
@jasonsaayman jasonsaayman restored the feat/improve-sponsors-run branch March 30, 2026 14:48
@jasonsaayman jasonsaayman deleted the feat/improve-sponsors-run branch March 30, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit::feat The PR is related to a feature priority::medium A medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant