Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding a clean step to Makefile #4393

Merged
merged 2 commits into from
May 13, 2024
Merged

Adding a clean step to Makefile #4393

merged 2 commits into from
May 13, 2024

Conversation

minhtuev
Copy link
Contributor

@minhtuev minhtuev commented May 10, 2024 •
edited by coderabbitai bot

What changes are proposed in this pull request?

Adding a clean step to Makefile so that we don't bundle existing dist content. I observed that running make python repeatedly right now will increase the size of the archived files because we are also bundling the dist content as well :)

How is this patch tested? If it is not, please explain why.

Tested locally and verified that the archived file no longer contains the dist folder.

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • Chores
    • Updated the packaging process to exclude the dist directory, ensuring cleaner distributions.
    • Enhanced the build process with a clean target to remove old distributions before creating new ones.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 10, 2024 •
edited

Walkthrough

The recent updates focus on refining the build process by excluding unnecessary directories and ensuring a clean state before each build. This involves pruning the dist directory from the distribution package and adding a clean target in the Makefile to remove old build artifacts.

Changes

File Summary of Changes
MANIFEST.in Added prune dist to exclude the dist directory.
Makefile 1. Added clean target to remove ./dist/*.
2. Updated python: app to python: app clean.

🐰✨
Oh hark! What changes we now see,
A cleaner build, as clean can be!
Prune the old, with care we sweep,
In dist no old files keep.
Hop and build, with joy anew,
For clean and tidy, through and through!
🌟🎉

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@minhtuev minhtuev self-assigned this May 10, 2024
@findtopher
Copy link
Member

I would suggest adding prune dist to the MANIFEST.in file too - that will prevent it from being included as well.

I wonder how many times we've shipped out wheels that had wheels in them 😊

@minhtuev
Copy link
Contributor Author

I would suggest adding prune dist to the MANIFEST.in file too - that will prevent it from being included as well.

I wonder how many times we've shipped out wheels that had wheels in them 😊

Wheel within wheel within wheel, sounds like a Dune reference :)

@minhtuev minhtuev marked this pull request as ready for review May 13, 2024 03:04
coderabbitai[bot]
coderabbitai bot reviewed May 13, 2024
View reviewed changes
Copy link
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

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 032220e and 60a3029.
Files selected for processing (2)
  • MANIFEST.in (1 hunks)
  • Makefile (1 hunks)
Files skipped from review due to trivial changes (1)
  • MANIFEST.in
Additional comments not posted (2)
Makefile (2)

8-10: The clean target is correctly defined to clear the dist directory.

11-11: Ensure the new dependency order in the python target does not introduce side effects in the build process.

benjaminpkane
benjaminpkane approved these changes May 13, 2024
View reviewed changes
Copy link
Contributor

@benjaminpkane benjaminpkane left a comment

Choose a reason for hiding this comment

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

Great catch! LGTM 🙇

@minhtuev minhtuev merged commit 86125ab into develop May 13, 2024
7 of 8 checks passed
@minhtuev minhtuev deleted the feat/add-clean-step-makefile branch May 13, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai left review comments

@benjaminpkane benjaminpkane benjaminpkane approved these changes

@sashankaryal sashankaryal Awaiting requested review from sashankaryal

Assignees

@minhtuev minhtuev

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@minhtuev @findtopher @benjaminpkane