Skip to content

Conversation

NiclasLindqvist
Copy link

@NiclasLindqvist NiclasLindqvist commented Sep 16, 2025

Summary

The outdated documentation suggested pulling 0.7.0 which is not available. Proposing to always pull latest.

List of files changed and why

README.md - Update docker example with latest image

How Has This Been Tested?

Locally, seems to run fine

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code

Summary by CodeRabbit

  • Documentation
    • Updated Docker Getting Started instructions to use the latest image tag instead of a fixed version (0.7.0).
    • Changed wording to “latest release version” for clarity.
    • Ensures users pull the most up-to-date image by default and simplifies the pull/run commands.
    • No functional changes to the application; documentation only.

The outdated documentation suggested pulling 0.7.0 which is not available. Proposing to always pull latest.
Copy link
Contributor

coderabbitai bot commented Sep 16, 2025

Walkthrough

Documentation update in README: Docker instructions changed from using a fixed image tag (0.7.0) and “release candidate” wording to using the latest tag and “latest release version” wording.

Changes

Cohort / File(s) Summary of changes
Docs: Docker usage update
README.md
Updated Docker commands from unclecode/crawl4ai:0.7.0 to unclecode/crawl4ai:latest; adjusted accompanying text from “latest release candidate” to “latest release version”.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nudge my nose at tags that fade,
From 0.7.0 to “latest” we’ve strayed.
A hop, a pull, then run we go—
Carrots cached, containers flow.
Documentation fresh and bright,
Ship the image, set to right! 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title "Update README.md with latest docker image" concisely and accurately summarizes the primary change (the README Docker example was updated to use the latest image tag). It is specific, short, and directly related to the files changed, so a reviewer can understand the main intent at a glance.
Description Check ✅ Passed The PR description follows the repository template by providing a Summary, a "List of files changed and why" (README.md), a "How Has This Been Tested?" entry, and a Checklist, so it is largely complete and on-topic. The testing section is brief ("Locally, seems to run fine") and would benefit from concrete steps and observed results, and the Checklist does not mark the documentation update or test-related items so those boxes should be updated to reflect the README change and any test verification performed.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

🧹 Nitpick comments (3)
README.md (3)

307-309: Don’t recommend :latest for production; add a pinning note (and example).

Using latest harms reproducibility and can break deployments on rebuilds. Keep latest for quickstart, but add a one‑liner showing how to pin a specific tag for prod.

Apply this minimal tweak to the snippet/comment:

-# Pull and run the latest release version
-docker pull unclecode/crawl4ai:latest
-docker run -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest
+# Quickstart: run the latest image (for production, pin a specific version tag)
+docker run --pull=always -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest
+# Example (recommended for prod): replace 'latest' with a tag, e.g. '0.7.4'
+# docker run -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:0.7.4

307-309: Use --pull=always and add a restart policy.

This removes the separate docker pull step and makes the container more resilient across host reboots.

-docker pull unclecode/crawl4ai:latest
-docker run -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest
+docker run --pull=always --restart unless-stopped -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest

307-307: Micro copy nit: clarify it’s the “latest Docker image.”

“Latest release version” can be misread as the Python package. Minor clarity gain.

-# Pull and run the latest release version
+# Pull and run the latest Docker image
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e651e04 and 120a5b3.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

307-309: Confirm latest points to the current release (0.7.4)

File: README.md lines 307–309

Registry check returned: 0.7.2, 0.7.3, 0.7.4, latest — latest exists. Ensure latest resolves to 0.7.4 (digest compare):

latest=$(curl -s -L 'https://hub.docker.com/v2/repositories/unclecode/crawl4ai/tags/latest' | jq -r '.images[]?.digest' | sort -u | tr '\n' ';'); v=$(curl -s -L 'https://hub.docker.com/v2/repositories/unclecode/crawl4ai/tags/0.7.4' | jq -r '.images[]?.digest' | sort -u | tr '\n' ';'); [ "$latest" = "$v" ] && echo MATCH || echo DIFFER

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