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

Renaming earth to earthly #618

Merged
merged 1 commit into from
Dec 14, 2020
Merged

Renaming earth to earthly #618

merged 1 commit into from
Dec 14, 2020

Conversation

alexcb
Copy link
Contributor

@alexcb alexcb commented Dec 14, 2020

  • when a user installs via brew, they type brew install earthly, so one would expect to find a command named earthly rather than earth
  • this git repo is located at github.com/earthly/earthly.git and not github.com/earthly/earth.git
  • Googling for earthly manages to find our documentation, where as the search-space for earth is much more crowded
  • earth easily tabs completes into earthly

@alexcb alexcb force-pushed the rename-earth-to-earthly branch 13 times, most recently from 5aae405 to acfbaea Compare December 14, 2020 22:08
@alexcb alexcb marked this pull request as ready for review December 14, 2020 22:28
@alexcb alexcb requested a review from vladaionescu December 14, 2020 22:28
@@ -8,12 +8,12 @@ import (
"github.com/pkg/errors"
)

// EarthIgnoreFile is the name of the earth ignore file.
// EarthIgnoreFile is the name of the earthly ignore file.
const EarthIgnoreFile = ".earthignore"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we're going to need some backwards compatibility if we want to rename this to .earthlyignore

Copy link
Member

Choose a reason for hiding this comment

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

The other possible one is Earthfile... Perhaps let's leave them like this for now.

Copy link
Member

@vladaionescu vladaionescu left a comment

Choose a reason for hiding this comment

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

  • Also rename docker2earth?
  • earthApp -> earthlyApp in main.go
  • Some other (maybe not very important) variables names still have names like earthTargetName (eg artifact.go). I guess it's ok to skip them for now.
  • Docs will be done in separate PR branched off next, right?
  • Changes to add symlink via bootstrap will be done in separate PR, right?

earthly Outdated
@@ -1,12 +1,12 @@
#!/bin/bash
set -e

bindir="$HOME/.earthly"
bindir="$HOME/.earth"
Copy link
Member

Choose a reason for hiding this comment

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

Why not use .earthly for this too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch, this was a mistaken search/replace.

README.md Outdated
@@ -319,7 +319,7 @@ release:
```

```bash
earth --secret GITHUB_TOKEN --push +release
earthly --secret GITHUB_TOKEN --push +release
Copy link
Member

Choose a reason for hiding this comment

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

Make changes in README on next branch instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's a good call, I left out the docs renaming for a different PR but let the README changes slip in, i'll save these for a future PR.

README.md Outdated
* #️⃣ [Earth command reference](https://docs.earthly.dev/earth-command)
* ⚙️ [Configuration reference](https://docs.earthly.dev/earth-config)
* #️⃣ [Earth command reference](https://docs.earthly.dev/earthly-command)
* ⚙️ [Configuration reference](https://docs.earthly.dev/earthly-config)
Copy link
Member

Choose a reason for hiding this comment

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

Note that these will require redirects in gitbook. See https://docs.gitbook.com/integrations/github/content-configuration

- when a user installs via brew, they type brew install earthly, so one would expect to find a command named earthly rather than earth
this git repo is located at github.com/earthly/earthly.git and not github.com/earthly/earth.git
- Googling for earthly manages to find our documentation, where as the search-space for earth is much more crowded
- earth easily tabs completes into earthly
@alexcb alexcb force-pushed the rename-earth-to-earthly branch from acfbaea to 9c03e71 Compare December 14, 2020 22:49
@alexcb
Copy link
Contributor Author

alexcb commented Dec 14, 2020

I renamed earthApp to earthlyApp in this PR; I'm hoping to do a follow up PR for docs, readmes, and other variable renames and more significant code changes like the bootstraping logic.

@alexcb alexcb merged commit 0120b24 into main Dec 14, 2020
@alexcb alexcb deleted the rename-earth-to-earthly branch December 14, 2020 23:11
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.

2 participants