Skip to content

docs: reword "earthly" -> "earthbuild" in internal Earthfile comments#643

Open
kmannislands wants to merge 1 commit into
mainfrom
reword-earthfile-comments
Open

docs: reword "earthly" -> "earthbuild" in internal Earthfile comments#643
kmannislands wants to merge 1 commit into
mainfrom
reword-earthfile-comments

Conversation

@kmannislands

Copy link
Copy Markdown

What

Rewords descriptive prose references to the project/tool in the comments of internal build, release, and test Earthfiles — e.g. # the earthly client that ships it# the earthbuild client, # lint runs ... against the earthly projectearthbuild project.

Scope / safety

Comment lines only. Deliberately left untouched:

  • Literal command examples (earthly +target, earthly config, earthly --config)
  • File/config paths (.earthlyignore, .earthly/config.yml, earthly_config)
  • URLs (github.com/earthly/..., homebrew-earthly, earthly/lib)
  • Env vars (EARTHLY_*) and released target names (earthly-linux-amd64, ...)
  • Commented-out RUN_EARTHLY code (owned by the UDC-rename PR test: rename RUN_EARTHLY test UDCs to RUN_EARTHBUILD #642)
  • User-facing examples/ and earthly doc behavior fixtures

Verification

  • Changed Earthfiles parse via earthly debug ast. The one parse failure — tests/invalid/leading-whitespace.earth — is an intentionally-invalid fixture testing the parser's error handling; it fails identically on main, and my edit there was comment-only.
  • Reduces the tracked earthly line count by 30.

🤖 Generated with Claude Code

Rewords descriptive prose references to the project/tool in the comments
of internal build, release, and test Earthfiles (e.g. "the earthly
client" -> "the earthbuild client", "lint runs ... against the earthly
project" -> "earthbuild project").

Scoped to comment lines only. Deliberately leaves untouched:
- literal command examples (`earthly +target`, `earthly config`, ...)
- file/config paths (.earthlyignore, .earthly/config.yml, earthly_config)
- URLs (github.com/earthly/..., homebrew-earthly, earthly/lib)
- env vars (EARTHLY_*) and released target names (earthly-linux-amd64, ...)
- commented-out RUN_EARTHLY code (owned by the UDC-rename PR)
- user-facing examples/ and `earthly doc` behavior fixtures

Changed Earthfiles parse via `earthly debug ast` (the sole parse
failure, tests/invalid/leading-whitespace.earth, is an intentionally
invalid fixture that fails identically on main).
Reduces "earthly" line count by 30.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@kmannislands kmannislands requested a review from a team as a code owner July 3, 2026 16:37
@kmannislands kmannislands requested review from janishorsts and removed request for a team July 3, 2026 16:37
@kmannislands kmannislands added the ai-assisted Authored with AI assistance label Jul 3, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

🎉 Are we earthbuild yet?

Great progress! You've reduced "earthly" occurrences by 30 (0.55%)

📈 Overall Progress

Branch Total Count
main 5408
This PR 5378
Difference -30 (0.55%)

📁 Changes by file type:

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

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 occurences of earthly in the source code due to backwards compatibility with config files and language constructs.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request systematically updates comments and documentation across various Earthfiles to replace references to 'earthly' with 'earthbuild'. There are no review comments, and I have no additional feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@janishorsts janishorsts left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

My mind is picking up on variations in names - Earthbuild, earthbuild, EarthBuild.

I perceive EarthBuild as org-level stuff, and earth as CLI-related. Not concerned about the naming. Yet.

Otherwise, it's ok.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-assisted Authored with AI assistance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants