✨ Make find-replace safer by default by enabling post revisions for changes by defaults.#698
✨ Make find-replace safer by default by enabling post revisions for changes by defaults.#698markstos wants to merge 1 commit intoTryGhost:mainfrom
Conversation
…hanges by defaults. fixes TryGhost#697 This aligns find-replace with how the Admin UI works. A boolean is flag is available to disable this safety feature for those want to live dangerously and not generate any more DB storage through their action. This work uncovered a bug on the server side where disabling post revisions doesn't actually work. A separate bug and PR was opened to fix that part. ref TryGhost/Ghost#26677
|
You have run out of free Bugbot PR reviews for this billing cycle. This will reset on April 3. To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial. |
WalkthroughThis PR introduces a new Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 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)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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
🧹 Nitpick comments (1)
prompts/find-replace.js (1)
105-110: Optional: showsaveRevisionprompt only when lexical is selected.Since this setting applies to lexical edits only, you can reduce prompt noise by gating it on
answers.where.includes('lexical').✂️ Suggested refinement
{ type: 'confirm', name: 'saveRevision', message: 'Create a post revision for each edited post? (lexical posts only)', - default: true + default: true, + when: (answers) => Array.isArray(answers.where) && answers.where.includes('lexical') }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@prompts/find-replace.js` around lines 105 - 110, The saveRevision confirm prompt is shown unconditionally but should only appear when the user selected lexical edits; update the prompt object named "saveRevision" to include a conditional "when" that checks answers.where.includes('lexical') (e.g., when: answers => answers.where && answers.where.includes('lexical')) so the question is only asked for lexical selections.
🤖 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`:
- Line 447: Add a brief note next to the --no-saveRevision flag documentation
warning that Ghost v6.20.0+ has a known bug (issue `#26677`) where the Admin API
ignores save_revision=false due to revision ordering logic, so revisions will
still be created; reference the Ghost version and issue number and suggest users
expect revisions to be saved until upstream fixes the bug.
In `@tasks/find-replace.js`:
- Around line 144-145: The task uses ctx.args.saveRevision (see the edit call in
find-replace.js where queryParams = ctx.args.saveRevision ? {save_revision:
true} : {}) but initialise() doesn't set a default; update the initialise()
defaults to include saveRevision: true so the task-layer enforces the safety
default even if caller omits it (modify the initialise() function/object that
seeds ctx.args to add saveRevision: true).
---
Nitpick comments:
In `@prompts/find-replace.js`:
- Around line 105-110: The saveRevision confirm prompt is shown unconditionally
but should only appear when the user selected lexical edits; update the prompt
object named "saveRevision" to include a conditional "when" that checks
answers.where.includes('lexical') (e.g., when: answers => answers.where &&
answers.where.includes('lexical')) so the question is only asked for lexical
selections.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0978a015-06aa-41c4-8bb6-4407a58385c4
📒 Files selected for processing (4)
README.mdcommands/find-replace.jsprompts/find-replace.jstasks/find-replace.js
|
|
||
| Use `-V` (`--verbose`) for detailed output showing which fields matched or were replaced in each post. | ||
|
|
||
| By default, `--saveRevision` is enabled, which creates a post revision for each edited post (lexical posts only). Use `--no-saveRevision` to disable this. |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Ghost GitHub issue 26677 save_revision false not taking effect
💡 Result:
In Ghost v6.20.0, this is a confirmed bug: the Admin API can create new post revisions even when you send ?save_revision=false (or 0). The issue report (#26677, opened Mar 3, 2026) explains that Ghost’s revision logic picks the wrong “latest” revision due to an ordering mismatch (revisions are fetched newest-first, but the code treats the last array element as “latest”). That makes the “background save” time check almost always pass, so revisions get saved whenever content changes—ignoring save_revision=false. [1]
What you can do
- If you need it fixed now: patch your Ghost install/fork so “latestRevision” uses the newest revision (e.g., the first element when ordered DESC), or adjust sorting so the newest revision is selected. (That’s the root cause described in the issue.) [1]
- Otherwise: you’ll likely have to wait for an upstream fix (the issue is labeled
needs:triageand, as of the report, has no assignee/milestone). [1]
Note
You may see save_revision=1 in normal Ghost Admin traffic—Ghost Admin appears to always send save_revision=true, which masks this bug for most UI usage. [1][2]
Sources: GitHub issue #26677 [1], related Ghost editor request example showing save_revision usage [2].
Document known Ghost limitation with --no-saveRevision.
Line 447 documents --no-saveRevision without noting that this feature is non-functional due to a confirmed bug in Ghost v6.20.0+ (issue #26677). The Admin API ignores the save_revision=false parameter due to a revision ordering logic error. Users should be warned that revisions will be saved regardless until Ghost upstream releases a fix. Consider adding a brief note to manage expectations.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 447, Add a brief note next to the --no-saveRevision flag
documentation warning that Ghost v6.20.0+ has a known bug (issue `#26677`) where
the Admin API ignores save_revision=false due to revision ordering logic, so
revisions will still be created; reference the Ghost version and issue number
and suggest users expect revisions to be saved until upstream fixes the bug.
| let queryParams = ctx.args.saveRevision ? {save_revision: true} : {}; | ||
| let result = await ctx.api.posts.edit(post, queryParams); |
There was a problem hiding this comment.
Enforce saveRevision default in task-layer defaults.
Line 144 relies on ctx.args.saveRevision being provided by callers. Add saveRevision: true to initialise() defaults so the safety default is preserved even if this task runner is reused outside current CLI/prompt flows.
💡 Suggested patch
let defaults = {
verbose: false,
tag: false,
- delayBetweenCalls: 50
+ delayBetweenCalls: 50,
+ saveRevision: true
};🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@tasks/find-replace.js` around lines 144 - 145, The task uses
ctx.args.saveRevision (see the edit call in find-replace.js where queryParams =
ctx.args.saveRevision ? {save_revision: true} : {}) but initialise() doesn't set
a default; update the initialise() defaults to include saveRevision: true so the
task-layer enforces the safety default even if caller omits it (modify the
initialise() function/object that seeds ctx.args to add saveRevision: true).
1 participant
fixes #697
This aligns find-replace with how the Admin UI works. A boolean is flag
is available to disable this safety feature for those want to live dangerously
and not generate any more DB storage through their action.
This work uncovered a bug on the server side where disabling post revisions
doesn't actually work. A separate bug and PR was opened to fix that part.
ref TryGhost/Ghost#26677