Skip to content

Commit

Permalink
wip: fixes markdown and spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
jmgilman committed Oct 30, 2023
1 parent 2fd0441 commit 2d6c875
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions docs/src/guides/languages/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ check:
DO ../../earthly/go+LINT --src="go.mod go.sum cmd"
```

With our depedencies installed, we're now ready to start operating with the source code.
With our dependencies installed, we're now ready to start operating with the source code.
To do this, we establish a dedicated `src` target that is solely responsible for copying the local source code into the context.
This is a common patern as it ensures we perform this only once and it makes future changes easier (as we only copy in a single
This is a common pattern as it ensures we perform this only once and it makes future changes easier (as we only copy in a single
place).
Any future targets which need access to the source code will inherit from this target.

Expand All @@ -107,7 +107,7 @@ These two UDCs will validate the code formatting is correct and also perform a s

Note that these checks are fast (compared to later steps) and perform quick feedback on code quality.
Since this is the first target run in CI, we want to fail the CI as quickly as possible if we can easily find code quality issues.
In future targets, we will run tests which can tend to take significantly more time to run than static anaylsis tools.
In future targets, we will run tests which can tend to take significantly more time to run than static analysis tools.

### Build and test

Expand Down Expand Up @@ -135,9 +135,9 @@ Since we need the source code to do this, we'll inherit from the `src` target.
The actual build process is fairly straight-forward, and the additional flags are simply there to ensure a fully static output is
created.

It's important we use `SAVE ARTIFACT` at the end of the build to make the compiled binary avaiable to other targets.
It's important we use `SAVE ARTIFACT` at the end of the build to make the compiled binary available to other targets.
Remember that targets can reference other targets, even ones in another `Earthfile`.
So by `SAVE ARTIFACT` here, we're making this binary avaiable to any other `Earthfile` which may need to use it.
So by `SAVE ARTIFACT` here, we're making this binary available to any other `Earthfile` which may need to use it.

Finally, after building the binary, we will run our tests.
In the case of this example, there are no actual tests to run, so the target will complete very quickly.
Expand Down Expand Up @@ -199,7 +199,7 @@ It also serves as a natural way to use our program without having to rely on a p

In this target, it's important we start with a "fresh" image by using `FROM`.
Unlike the previous targets, here the size of the image matters as the resulting image will be published to a registry.
In our case, we just take a plain `alpine` image as we don't need any of the Go tooling we used previosuly (since the binary has
In our case, we just take a plain `alpine` image as we don't need any of the Go tooling we used previously (since the binary has
already been built for us).

We add a `tag` argument out of convention.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ It's critical to understand what those tools are and how they interact together
The quickest way to get started learning is by going through the [onboarding process](./onboarding/index.md).
For more in-depth documentation, please review the [reference section](./reference/index.md).
Before contributing to an `Earthfile`, please review the [style guide](./style.md).
If you want to learn how to build an `Earthfile` from scratch, check out the [available guides](./guides/index.md).
If you want to learn how to build an `Earthfile` from scratch, check out the [available guides](./guides/index.md).

0 comments on commit 2d6c875

Please sign in to comment.