Skip to content

chore: auto-update cli docs from upstream - #724

Open
cploujoux wants to merge 1 commit into
mainfrom
auto-update-docs-cli
Open

chore: auto-update cli docs from upstream#724
cploujoux wants to merge 1 commit into
mainfrom
auto-update-docs-cli

Conversation

@cploujoux

@cploujoux cploujoux commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Automated update of CLI docs


Open in Devin Review

Note

Auto-updated CLI docs for bl new command: adds GitHub Actions runner as a job use case, updates post-creation instructions to be more generic, adds a new example for non-interactive GitHub runner creation, and clarifies that --yes flag requires --template for job creation.

Written by Mendral for commit 8b2ce44.

@mendral-app

mendral-app Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

🔍 PR Change Analysis

This PR is a documentation-only update to the CLI reference (cli-reference/commands/bl_new.md). No code, services, or runtime components are affected, so a sequence diagram isn't applicable here.

Summary of Changes

Area Change
job resource type Added "GitHub Actions runners" as a use case
Post-creation steps Simplified from 5 steps to 4, now referencing resource-specific instructions
Examples Added bl new job my-github-runner -t github-runner -y example
--yes flag Clarified that job creation also requires --template

No inter-component interactions are introduced or modified by this change.

Note

Posted by PR Sequence Diagram · Tag @mendral-app with feedback.

@mendral-app

mendral-app Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

🧪 Testing Guide

What this PR addresses

This is an automated documentation update for the bl new CLI command. Changes include:

  • Adding "GitHub Actions runners" as a use case for the job resource type
  • Simplifying the "After Creation" steps to be more generic (pointing users to resource-specific instructions instead of a fixed workflow)
  • Adding a new example for creating a GitHub Actions runner job non-interactively
  • Clarifying the --yes flag description to note that job creation also requires --template

Steps to verify

Since this is a documentation-only change with no code impact, there are no reproduction steps. Instead, verify:

  1. Open the rendered markdown for cli-reference/commands/bl_new.md and confirm it renders correctly (no broken formatting or indentation issues).
  2. Check that the new example (bl new job my-github-runner -t github-runner -y) is consistent with the updated --yes flag description (which now states job creation also requires --template).
  3. Confirm the "After Creation" steps still read clearly and make sense as generic guidance.

What to verify (expected behavior)

  • No markdown rendering issues (especially around the indented use-case lines and the code blocks).
  • The documentation accurately reflects the current CLI behavior (the upstream source of truth for this auto-generated update).
  • No unintended removals of important information — the old steps 3–5 ("Develop locally with hotreload → Test → Deploy") are now condensed into "Follow resource-specific instructions" which is intentionally more generic.

Note

Posted by PR Testing Guide · Tag @mendral-app with feedback.

@mendral-app mendral-app Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

Documentation-only change updating the bl new CLI reference. The updates are consistent and accurate: the --yes flag description now correctly notes the --template dependency for jobs, matching the new example. No security, correctness, or data risks.

Tag @mendral-app with feedback or questions. View session

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@mendral-app

mendral-app Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

📋 Created Linear issue ENG-4569 — status: In Progress

  • Assignee: Christophe Ploujoux
  • Labels: Doc, CLI
  • Estimate: XS (1 file, ~13 lines)
  • PR linked: ✅ Issue will auto-close when this PR merges

Auto-created because no Linear reference was found in the PR title, description, or branch name.

⚠️ Note: Could not prepend Fixes ENG-4569 to the PR description due to a GitHub API deprecation error. Please add it manually if needed.

Note

Posted by Linear Issue Enforcer · Tag @mendral-app with feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants