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.

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

Define storage for static files #54

Merged
merged 1 commit into from
Oct 14, 2024
Merged

Define storage for static files #54

merged 1 commit into from
Oct 14, 2024

Conversation

sebastienbarbier
Copy link
Member

@sebastienbarbier sebastienbarbier commented Oct 14, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a custom storage solution for static and media files, enhancing file management.
    • Added a new StaticStorage class for improved static file handling.
  • Improvements

    • Updated media file handling to allow overwriting of existing files.
    • Adjusted configurations for serving media files from a custom S3 domain.

@sebastienbarbier sebastienbarbier merged commit 246302a into main Oct 14, 2024
1 check passed
Copy link

coderabbitai bot commented Oct 14, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on updating the Django settings for static and media file storage. The STATICFILES_STORAGE and DEFAULT_FILE_STORAGE settings have been modified to use a custom storage backend. A new StaticStorage class has been introduced, and the existing MediaStorage class has been updated to allow file overwriting. Additionally, the STATIC_ROOT and MEDIA_URL configurations have been adjusted to reflect these changes, indicating a significant shift towards a more customized file management approach.

Changes

File Change Summary
src/core/settings.py Updated STATICFILES_STORAGE to core.storage_backends.StaticStorage, DEFAULT_FILE_STORAGE to core.storage_backends.MediaStorage, and set STATIC_ROOT to os.path.join(BASE_DIR, 'collectstatic'). Updated MEDIA_URL to use AWS_S3_CUSTOM_DOMAIN. Adjusted ALERTMANAGER_WEBHOOK_URL construction.
src/core/storage_backends.py Added StaticStorage class extending S3Boto3Storage with file_overwrite=True. Updated MediaStorage to set file_overwrite to True.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DjangoApp
    participant S3Storage

    User->>DjangoApp: Request for static/media file
    DjangoApp->>S3Storage: Retrieve file from StaticStorage/MediaStorage
    S3Storage-->>DjangoApp: Return file
    DjangoApp-->>User: Serve file
Loading

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>, please review it.
    • 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 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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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

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.

1 participant