chore: event-driven self-deploy; README documents both cadences#8
Conversation
Drops the daily cron from znat/gitpulse's self-deploy in favour of push + release event triggers. New content (PRs, direct pushes, releases) now appears on the site within a couple of minutes of landing instead of waiting up to a day. README install snippet now offers consumers two cadences: - Option A (event-driven, recommended): push + release + manual. Re-publishes the moment something changes; no idle runs. - Option B (daily): cron at 09:00 UTC + manual. Lower CI footprint for repos with sporadic activity; new content lags up to a day. Both work; consumers can switch by editing their workflow file.
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughChanges update deployment automation and build configuration: the self-deploy workflow now triggers on published releases instead of a scheduled cron, README adds two workflow setup options (event-driven or daily), and the site build script runs ChangesSelf-deploy & Install Docs
Build script
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 9/10 reviews remaining, refill in 6 minutes. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 23-30: The docs claim the workflow runs on the repository's
default branch but the snippet hardcodes branches: [main]; update the workflow
example (the Gitpulse workflow name and the on: push: branches: [main] block) to
remove the branches filter so push triggers are not limited to "main" (i.e., use
on: push without branches) so the workflow actually runs on the repo's default
branch across different repos.
- Around line 21-47: The "Option A — event-driven (recommended)" and "Option B —
daily" headings are using level-4 headings (####) but should be level-3 (###) to
sit directly under the "## Install" section and satisfy MD001; update the
heading markers for both "Option A — event-driven (recommended)" and "Option B —
daily" (and any adjacent cadence option headings) from "####" to "###" so the
markdown hierarchy is consistent.
🪄 Autofix (Beta)
✅ Autofix completed
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 1718e9bf-046e-405c-bd12-057d5ca5fab2
📒 Files selected for processing (2)
.github/workflows/self-deploy.ymlREADME.md
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. Fixes Applied SuccessfullyFixed 1 file(s) based on 2 unresolved review comments. Files modified:
Commit: The changes have been pushed to the Time taken: |
Fixed 1 file(s) based on 2 unresolved review comments. Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 23-30: The prose says "default branch" but the YAML snippet uses a
broad push trigger (`on: push:`) which fires for all branches; either restrict
the YAML push trigger to the repository's default branch (e.g., replace `on:
push:` with a branch-scoped trigger like `on: push: branches: - main` or `-
${default_branch}`) or change the prose to say "all branches" so it matches the
`on: push:` usage; update the `on: push:`/`release:` snippet and the sentence
mentioning "default branch" so both describe the same scope.
🪄 Autofix (Beta)
✅ Autofix completed
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. Fixes Applied SuccessfullyFixed 2 file(s) based on 1 unresolved review comment. Files modified:
Commit: The changes have been pushed to the Time taken: |
Fixed 2 file(s) based on 1 unresolved review comment. Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@site/next.config.js`:
- Around line 11-13: Remove the unsupported experimental.turbo config: delete
the experimental block (specifically the experimental: { turbo: undefined }
entry) from the Next.js config, and if you intended to enable the new bundler
set the top-level turbopack key instead (e.g., add a turbopack setting) so the
config uses turbopack rather than experimental.turbo.
🪄 Autofix (Beta)
✅ Autofix completed
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 52d4e315-35f4-4ee6-aa2d-f448eda82293
📒 Files selected for processing (2)
README.mdsite/next.config.js
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. The agent ran but didn't make any changes. The issues may already be fixed or require manual intervention. |
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. Fixes Applied SuccessfullyFixed 2 file(s) based on 1 unresolved review comment. Files modified:
Commit: The changes have been pushed to the Time taken: |
Fixed 2 file(s) based on 1 unresolved review comment. Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@site/package.json`:
- Line 7: The package.json "build" script currently uses an invalid Next.js flag
"--no-turbo"; update the "build" npm script (the "build" field in package.json)
to replace "--no-turbo" with a valid bundler flag such as "--webpack" (or
"--turbopack" if you prefer Turbopack) so the Next.js build command succeeds,
and keep the existing post-build step (node scripts/rename-og-png.mjs)
unchanged.
🪄 Autofix (Beta)
✅ Autofix completed
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: dc333b18-b5d1-4a54-8ab3-0b13f82a1b0e
📒 Files selected for processing (1)
site/package.json
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. Fixes Applied SuccessfullyFixed 1 file(s) based on 1 unresolved review comment. Files modified:
Commit: The changes have been pushed to the Time taken: |
Fixed 1 file(s) based on 1 unresolved review comment. Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
|
| Filename | Overview |
|---|---|
| .github/workflows/self-deploy.yml | Replaces daily cron trigger with release: types: [published]; keeps the existing push and workflow_dispatch triggers intact. |
| README.md | Splits installation example into Option A (event-driven, recommended) and Option B (daily cron); both snippets are syntactically correct and complete. |
| site/package.json | Adds --webpack to next build to opt out of Turbopack (Next.js 16 default), which is the documented flag for this purpose. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Push to main] -->|push trigger| D[self-deploy.yml]
B[Release published] -->|release: published| D
C[Manual trigger] -->|workflow_dispatch| D
D --> E[publish.yaml reusable workflow]
E --> F[Gitpulse site deployed to Pages]
subgraph "Dropped trigger"
G["⏱ schedule: cron 0 9 * * *"]
end
G -.->|removed| D
Reviews (1): Last reviewed commit: "fix: apply CodeRabbit auto-fixes" | Re-trigger Greptile
1 participant
Summary
Two changes addressing your earlier question about replacing the cron with event triggers.
`self-deploy.yml` — event-driven
```diff
on:
push:
branches: [main]
workflow_dispatch:
```
znat/gitpulse will now re-publish on every commit landing on `main` and on every `release: published` event (covers regular releases + pre-releases). Drops the idle daily cron run.
README — both cadences offered
The install snippet now presents two options for consumers, with a one-line tradeoff each:
Either snippet is copy-paste ready. Consumers can change their mind later by editing the file.
Test plan
Summary by CodeRabbit
Documentation
Chores