Update releases#458
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR updates documentation for custom automations, releases, and feature tier classifications. Custom automations documentation is refined with expanded action types (Send webhook), template variable guidance, and conceptual explanations of automation execution flow. Releases documentation is restructured with workspace-level setup and new sections for release creation, work item linking, and release management. Feature tier badges are reclassified across three documentation files. ChangesCustom Automations Documentation Update
Releases Feature Documentation Rewrite
Feature Tier Badge Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/automations/custom-automations.md (1)
1-302:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFormatting check is currently CI-blocking.
Line 1 onward:
oxfmt --checkis failing for this file set, so this PR cannot pass formatting CI until formatter output is applied. Please run the formatter and commit the result before merge.As per coding guidelines, "
**/*: Run pnpm fix:format before committing and ensure CI check via pnpm check:format passes; formatting is enforced".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/automations/custom-automations.md` around lines 1 - 302, The file fails the repository formatter check (oxfmt --check) and CI requires formatted output; run the project's formatting commands (pnpm fix:format or run oxfmt on the docs) to reformat the "Custom automations" markdown, verify with pnpm check:format (or oxfmt --check) and commit the updated file so CI passes; ensure you only change whitespace/formatting and do not alter content.docs/releases.md (1)
1-234:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFix formatting to unblock CI
Formatting is currently failing (
oxfmt --check). Please run the repo formatter and re-run format checks before merge.As per coding guidelines, "Run pnpm fix:format before committing and ensure CI check via pnpm check:format passes; formatting is enforced".
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/releases.md` around lines 1 - 234, Formatting check is failing for docs/releases.md (oxfmt --check); run the repo formatter and commit the fixed file: run the project formatting script (pnpm fix:format) locally to reformat this file (or run oxfmt on docs/releases.md), verify with pnpm check:format (or oxfmt --check) and then update the commit/PR so CI passes; reference the repo formatting scripts (pnpm fix:format and pnpm check:format) when making the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/automations/custom-automations.md`:
- Around line 176-178: Update the fenced code block that currently contains
"This item has been moved to a new state. Current priority: {{priority}}. Please
check if the due date needs updating." by adding a language identifier (e.g.,
text) after the opening triple backticks so the block becomes ```text ... ```,
ensuring markdown linting passes; locate the block by searching for that exact
string in docs/automations/custom-automations.md and replace the opening ```
with ```text.
---
Outside diff comments:
In `@docs/automations/custom-automations.md`:
- Around line 1-302: The file fails the repository formatter check (oxfmt
--check) and CI requires formatted output; run the project's formatting commands
(pnpm fix:format or run oxfmt on the docs) to reformat the "Custom automations"
markdown, verify with pnpm check:format (or oxfmt --check) and commit the
updated file so CI passes; ensure you only change whitespace/formatting and do
not alter content.
In `@docs/releases.md`:
- Around line 1-234: Formatting check is failing for docs/releases.md (oxfmt
--check); run the repo formatter and commit the fixed file: run the project
formatting script (pnpm fix:format) locally to reformat this file (or run oxfmt
on docs/releases.md), verify with pnpm check:format (or oxfmt --check) and then
update the commit/PR so CI passes; reference the repo formatting scripts (pnpm
fix:format and pnpm check:format) when making the change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 914d4884-638a-4656-9f01-0158f7cb6295
📒 Files selected for processing (5)
docs/automations/custom-automations.mddocs/automations/overview.mddocs/core-concepts/issues/plane-query-language.mddocs/core-concepts/pages/editor-blocks.mddocs/releases.md
| ``` | ||
| This item has been moved to a new state. Current priority: {{priority}}. Please check if the due date needs updating. | ||
| ``` |
There was a problem hiding this comment.
Add a language identifier to the fenced code block.
Line 176 uses a plain triple-backtick block; specify the language (e.g., text) to satisfy markdown linting and keep docs lint-clean.
Proposed fix
-```
+```text
This item has been moved to a new state. Current priority: {{priority}}. Please check if the due date needs updating.</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>
[warning] 176-176: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @docs/automations/custom-automations.md around lines 176 - 178, Update the
fenced code block that currently contains "This item has been moved to a new
state. Current priority: {{priority}}. Please check if the due date needs
updating." by adding a language identifier (e.g., text) after the opening triple
backticks so the block becomes text ... , ensuring markdown linting
passes; locate the block by searching for that exact string in
docs/automations/custom-automations.md and replace the opening withtext.
</details>
<!-- fingerprinting:phantom:triton:hawk -->
<!-- This is an auto-generated comment by CodeRabbit -->
2 participants
Summary by CodeRabbit