Skip to content

Add phony targets#115

Merged
leynos merged 2 commits intomainfrom
codex/add-phony-targets-to-makefile
Jun 12, 2025
Merged

Add phony targets#115
leynos merged 2 commits intomainfrom
codex/add-phony-targets-to-makefile

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 12, 2025

Summary

  • add all, clean, and test to .PHONY
  • provide standard all, clean, and test targets in the Makefile

Testing

  • cargo clippy -- -D warnings
  • cargo test --quiet

https://chatgpt.com/codex/tasks/task_e_684abfbf7a18832299bb533c09fee7fb

Summary by Sourcery

Introduce standard Makefile phony targets to streamline building, testing, and cleaning.

Build:

  • Add .PHONY entries for all, clean, and test targets
  • Implement all to build the default release, clean to remove artifacts, and test to run the test suite

Summary by CodeRabbit

  • Chores
    • Introduced standard build, clean, and test commands to streamline project management.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 12, 2025

Reviewer's Guide

This PR enhances the Makefile by updating the .PHONY list and adding standard 'all', 'clean', and 'test' targets to streamline build, cleanup, and test workflows.

Sequence Diagram for 'make clean' Target Interaction

sequenceDiagram
    actor Developer
    participant Makefile
    participant Cargo
    participant "File System" as FS

    Developer->>Makefile: Executes 'make clean'
    activate Makefile
    Makefile->>Cargo: Executes 'cargo clean'
    activate Cargo
    Cargo-->>Makefile: 'cargo clean' completed
    deactivate Cargo
    Makefile->>FS: Executes 'rm -rf target/postgres'
    activate FS
    FS-->>Makefile: Deletion completed
    deactivate FS
    Makefile-->>Developer: 'make clean' completed
    deactivate Makefile
Loading

Sequence Diagram for 'make test' Target Interaction

sequenceDiagram
    actor Developer
    participant Makefile
    participant Cargo

    Developer->>Makefile: Executes 'make test'
    activate Makefile
    Makefile->>Cargo: Executes 'cargo test'
    activate Cargo
    Cargo-->>Makefile: Test results
    deactivate Cargo
    Makefile-->>Developer: 'make test' completed
    deactivate Makefile
Loading

File-Level Changes

Change Details Files
Update .PHONY declarations
  • Added 'all', 'clean', and 'test' to the .PHONY line
Makefile
Introduce 'all', 'clean', and 'test' targets
  • Defined 'all' as alias for sqlite-release target
  • Implemented 'clean' to run cargo clean and remove the postgres build directory
  • Added 'test' to invoke cargo test
Makefile

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 12, 2025

Walkthrough

The Makefile was updated to add standard build lifecycle targets: all, clean, and test. These targets were also included in the .PHONY list. The all target builds the sqlite-release, clean removes build artefacts, and test runs the project's tests.

Changes

File Change Summary
Makefile Added .PHONY entries and new targets: all, clean, and test for build, clean, and test

Possibly related PRs

Poem

A rabbit hops with nimble feet,
New targets in the Makefile neat!
Build it all, then clean with glee,
Or run your tests—so easily.
With every hop, the project grows,
In tidy code, the progress shows! 🐇


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
Makefile (2)

11-12: Consider expanding the default all target
Currently all only builds sqlite-release. If you’d like make all to produce both SQLite and Postgres binaries, you could change it to:

-all: sqlite-release
+all: sqlite-release postgres-release

17-19: Align test target with local workflow and fix indentation

  1. Ensure the cargo test command is indented with a tab.
  2. To mirror your CI invocation (cargo test --quiet), you might update it to:
-test:
-	cargo test
+test:
+	cargo test --quiet
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b99eca4 and f1496b4.

📒 Files selected for processing (1)
  • Makefile (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build-test (sqlite)
  • GitHub Check: coverage
  • GitHub Check: build-test (postgres)
🔇 Additional comments (2)
Makefile (2)

1-1: Phony targets inclusion is correct
The .PHONY declaration now explicitly lists all, clean, and test alongside existing targets, ensuring Make won’t try to build files of those names.


13-16: Verify command indentation under clean
Makefile recipes must be indented with a tab, not spaces. Please confirm these lines use a leading tab to avoid parsing errors.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes - here's some feedback:

  • The all target currently only builds sqlite-release; consider including postgres-release (and other build targets) to make all truly comprehensive.
  • Since cargo clean already removes the entire target directory, the manual rm -rf target/postgres step in clean may be redundant.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The all target currently only builds sqlite-release; consider including postgres-release (and other build targets) to make all truly comprehensive.
- Since cargo clean already removes the entire target directory, the manual rm -rf target/postgres step in clean may be redundant.

## Individual Comments

### Comment 1
<location> `Makefile:11` </location>
<code_context>
 sqlite-release: target/release/mxd
 postgres-release: target/postgres/release/mxd

+all: sqlite-release
+
+clean:
</code_context>

<issue_to_address>
Expand default all target for completeness

Consider adding `postgres-release` and other relevant artifacts to the `all` target so that running `make` builds all deliverables by default.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
all: sqlite-release

=======
all: sqlite-release postgres-release

>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread Makefile
Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

@leynos leynos merged commit d9b6e4e into main Jun 12, 2025
2 of 4 checks passed
@leynos leynos deleted the codex/add-phony-targets-to-makefile branch June 12, 2025 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant