-
Notifications
You must be signed in to change notification settings - Fork 405
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
Conversation
5aae405
to
acfbaea
Compare
@@ -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" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this 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
(egartifact.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" |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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
acfbaea
to
9c03e71
Compare
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. |
brew install earthly
, so one would expect to find a command namedearthly
rather thanearth
github.com/earthly/earthly.git
and notgithub.com/earthly/earth.git
earthly
manages to find our documentation, where as the search-space forearth
is much more crowdedearth
easily tabs completes intoearthly