Skip to content

chore(earthfile): update earthly to earth in comments - #945

Open
janishorsts wants to merge 1 commit into
mainfrom
chore-earthfile-comment-earthly
Open

janishorsts wants to merge 1 commit into
mainfrom
chore-earthfile-comment-earthly

Conversation

@janishorsts

@janishorsts janishorsts commented Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Updated example commands and descriptions to use the current earth command terminology.
    • Refreshed secret-provisioning, multiplatform, cutoff-optimization, and gRPC examples.
    • Updated release documentation to reference Earth-inferred commit values.
    • Corrected the Azure Container Registry example endpoint.
    • Cleaned up outdated build and troubleshooting comments without changing build behavior.

@janishorsts janishorsts self-assigned this Sep 17, 2026
@janishorsts
janishorsts requested a review from a team as a code owner September 17, 2026 08:30
@janishorsts
janishorsts requested review from gilescope and removed request for a team September 17, 2026 08:30
@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 69e329d1-4052-4519-b7cc-0ab4d9370763

📥 Commits

Reviewing files that changed from the base of the PR and between ee6be11 and b4493c0.

📒 Files selected for processing (8)
  • Earthfile
  • examples/cutoff-optimization/Earthfile
  • examples/grpc/Earthfile
  • examples/multiplatform/Earthfile
  • examples/secrets/Earthfile
  • release/Earthfile
  • tests/cloud-push-pull/Earthfile
  • tests/integration-base/Earthfile
💤 Files with no reviewable changes (1)
  • tests/integration-base/Earthfile

Included review availability: Your plan provides up to 10 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The change updates comments, documented commands, and commented test references to use current Earth naming. It removes obsolete comments. No build behavior changes.

Changes

Earth naming and comment cleanup

Layer / File(s) Summary
Root build comments
Earthfile
Updated target descriptions and removed an obsolete Homebrew synchronization comment.
Example command documentation
examples/cutoff-optimization/Earthfile, examples/grpc/Earthfile, examples/multiplatform/Earthfile, examples/secrets/Earthfile
Updated documented commands and comments from earthly to earth.
Release and test references
release/Earthfile, tests/cloud-push-pull/Earthfile, tests/integration-base/Earthfile
Updated release SHA comments, corrected the Azure registry host, and removed a commented debug command.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to b4493

This documentation-only update does not introduce a known production or build risk and is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: updating comments and examples from “earthly” to “earth.”
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore-earthfile-comment-earthly

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

@github-actions

Copy link
Copy Markdown

🎉 Are we earthbuild yet?

Great progress! You've reduced "earthly" occurrences by 16 (0.57%)

📈 Overall Progress

Branch Total Count
main 2813
This PR 2797
Difference -16 (0.57%)

📁 Changes by file type:

File Type Change
Go files (.go) ➖ No change
Documentation (.md) ➖ No change
Earthfiles ✅ -16

Keep up the great work migrating from Earthly to Earthbuild! 🚀

💡 Tips for finding more occurrences

Run locally to see detailed breakdown:

./.github/scripts/count-earthly.sh

Note that the goal is not to reach 0.
There is anticipated to be at least some occurrences of earthly in the source code due to backwards compatibility with config files and language constructs.

@janishorsts janishorsts moved this from Todo to In Progress in v0.8.20 Release Sep 17, 2026
@janishorsts janishorsts added this to the v0.8.20 milestone Sep 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

1 participant