Skip to content

feat: add docs for justfile - #1648

Open
ZohebShaikh wants to merge 4 commits into
justfile-fixfrom
add-docs-just-file
Open

feat: add docs for justfile#1648
ZohebShaikh wants to merge 4 commits into
justfile-fixfrom
add-docs-just-file

Conversation

@ZohebShaikh

Copy link
Copy Markdown
Contributor
just --list
Available recipes:
    compose +ARGS="up -d --no-recreate" # Bring up the example services with docker/podman compose
    coverage                            # Run unit tests with coverage and open the HTML report
    default                             # Start the example services via compose and run the blueapi server
    init-example-services               # Clone the example-services submodule if needed but leave it alone otherwise
    lint                                # Regenerate schemas, run pre-commit checks and type checking
    repl                                # Start an interactive REPL logged in to a blueapi client
    run PLAN PARAMS                     # Run a plan against the blueapi controller
    serve *OPTS                         # Run the blueapi server against the system test config
    system *OPTS                        # Run the system test suite
    unit *OPTS="-n logical"             # Run the unit test suite

Shows docs. I have example a vscode plugin which has made some spacing changes.

I have also added just to completion in dev-container for ease of use

@ZohebShaikh
ZohebShaikh requested a review from a team as a code owner September 1, 2026 08:33
@codecov

codecov Bot commented Sep 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.34%. Comparing base (d55ed6e) to head (615acd1).

Additional details and impacted files
@@              Coverage Diff              @@
##           justfile-fix    #1648   +/-   ##
=============================================
  Coverage         96.34%   96.34%           
=============================================
  Files                46       46           
  Lines              3666     3666           
=============================================
  Hits               3532     3532           
  Misses              134      134           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tpoliaw tpoliaw 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.

The docs are good, thanks for adding them, mainly insure what should be here vs in the upstream projects.

Comment thread Dockerfile Outdated
Comment thread justfile Outdated
Comment thread justfile Outdated
Comment thread justfile Outdated
Comment thread justfile Outdated
Comment thread .devcontainer/devcontainer.json Outdated
@tpoliaw

tpoliaw commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Was there a reason for preferring the [doc(...)] format over the plain comment docstring approach?

[doc('comment here')]
recipe:
   ...

vs

# comment here
recipe:
    ...

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.

3 participants