Skip to content

Commit

Permalink
Merge branch 'master' into feat/openapi-lint
Browse files Browse the repository at this point in the history
  • Loading branch information
bkioshn committed Jan 18, 2024
2 parents 3b0ca9e + 9b5e173 commit 2818e2d
Show file tree
Hide file tree
Showing 53 changed files with 606 additions and 630 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ jobs:
deployment_repo: ${{ inputs.deployment_repo }}
images: ${{ inputs.deployment_images }}
secrets:
token: ${{ secrets.deployment_token }}
token: ${{ secrets.deployment_token }}
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ jobs:
author_name: catalyst-cibot
author_email: ci@projectcatalyst.io
message: "chore: updates ${{ github.event.repository.name }} deployments"
push: true
push: true
2 changes: 1 addition & 1 deletion .github/workflows/dogfood.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
aws_ecr_registry: 332405224602.dkr.ecr.eu-central-1.amazonaws.com
aws_role_arn: arn:aws:iam::332405224602:role/ci
aws_region: eu-central-1
ci_cli_version: 2.2.3
ci_cli_version: 2.3.0
secrets:
dockerhub_token: ${{ secrets.DOCKERHUB_TOKEN }}
dockerhub_username: ${{ secrets.DOCKERHUB_USERNAME }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -172,4 +172,4 @@ jobs:
${{ inputs.aws_ecr_registry }}
ghcr.io/${{ github.repository }}
tags: |
${{ steps.fetch_tag.outputs.tag }}
${{ steps.fetch_tag.outputs.tag }}
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -170,4 +170,4 @@ jobs:
- name: Create release
uses: softprops/action-gh-release@v1
with:
files: ${{ steps.collect.outputs.artifacts }}
files: ${{ steps.collect.outputs.artifacts }}
2 changes: 1 addition & 1 deletion Earthfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Set the Earthly version to 0.7
VERSION --global-cache 0.7
VERSION --global-cache --use-function-keyword 0.7

# cspell: words livedocs sitedocs

Expand Down
6 changes: 3 additions & 3 deletions cli/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ require (
github.com/Masterminds/semver/v3 v3.2.1
github.com/alecthomas/kong v0.7.1
github.com/aws/aws-sdk-go v1.44.274
github.com/earthly/earthly/ast v0.0.2-0.20230524145153-17fad8c8f79b
github.com/earthly/earthly/ast v0.0.2-0.20231213200555-95fef7ce99cb
github.com/onsi/ginkgo/v2 v2.9.7
github.com/onsi/gomega v1.27.7
github.com/spf13/afero v1.9.5
gopkg.in/yaml.v3 v3.0.1
)

require (
Expand All @@ -24,8 +23,9 @@ require (
github.com/pkg/errors v0.9.1 // indirect
golang.org/x/exp v0.0.0-20230224173230-c95f2b4c22f2 // indirect
golang.org/x/net v0.10.0 // indirect
golang.org/x/sys v0.8.0 // indirect
golang.org/x/sys v0.11.0 // indirect
golang.org/x/text v0.9.0 // indirect
golang.org/x/tools v0.9.1 // indirect
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
10 changes: 5 additions & 5 deletions cli/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ3
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/earthly/earthly/ast v0.0.2-0.20230524145153-17fad8c8f79b h1:kwdLqircFHqYNLrBuSOybPpGPnqaqXEcRvJOWiSqRZw=
github.com/earthly/earthly/ast v0.0.2-0.20230524145153-17fad8c8f79b/go.mod h1:OoxU/3mRER8gdd4l1lxF6EgK+0vf7zQ8m9g269y6hWI=
github.com/earthly/earthly/ast v0.0.2-0.20231213200555-95fef7ce99cb h1:dP0Wcrfbq5whzPCT/ZHGTvWVvx7S6BoF32nRHqhKt7E=
github.com/earthly/earthly/ast v0.0.2-0.20231213200555-95fef7ce99cb/go.mod h1:UX9246125xgKvMIKim7WTxR8nookovxWx8/Ze8kpYlQ=
github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
Expand Down Expand Up @@ -164,7 +164,7 @@ github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
github.com/pkg/sftp v1.13.1/go.mod h1:3HaPG6Dq1ILlpPZRO0HVMrsydcdLt6HRDccSgb87qRg=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/poy/onpar v0.3.1 h1:iqwl2S3U08PY8Bm9Hfh9v3fxdig7hZy9bsZfTephng8=
github.com/poy/onpar v0.3.2 h1:yo8ZRqU3C4RlvkXPWUWfonQiTodAgpKQZ1g8VTNU9xU=
github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
github.com/spf13/afero v1.9.5 h1:stMpOSZFs//0Lv29HduCmli3GUfpFoF3Y1Q/aXj/wVM=
Expand Down Expand Up @@ -325,8 +325,8 @@ golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBc
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU=
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM=
golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
Expand Down
2 changes: 1 addition & 1 deletion cli/pkg/earthfile.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type Earthfile struct {
Path string `json:"path,omitempty"`
SourceLocation *spec.SourceLocation `json:"sourceLocation,omitempty"`
Targets []spec.Target `json:"targets,omitempty"`
UserCommands []spec.UserCommand `json:"userCommands,omitempty"`
Functions []spec.Function `json:"functions,omitempty"`
Version *spec.Version `json:"version,omitempty"`
}

Expand Down
2 changes: 1 addition & 1 deletion cli/pkg/parsers/earthly_parser.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func (e EarthlyParser) Parse(path string) (pkg.Earthfile, error) {
Path: path,
SourceLocation: ef.SourceLocation,
Targets: ef.Targets,
UserCommands: ef.UserCommands,
Functions: ef.Functions,
Version: ef.Version,
}, nil
}
Expand Down
6 changes: 3 additions & 3 deletions docs/src/guides/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ src:

The first step of building process it preparing a source files.
It is mandatory to have a `src` directory with all documentation md files in it and `mkdocs.yml` file.
This directory and file will be picked during the execution of `+SRC` UDC target.
This directory and file will be picked during the execution of `+SRC` Function.
Also it is possible to replace defined `includes`, `macros` and `overrides` dirs
to customize some docs appearance and configuration.

Expand All @@ -78,7 +78,7 @@ docs:
DO ../earthly/docs+BUILD
```

To build a docs artifact which will be used later just invoke `+BUILD` UDC target
To build a docs artifact which will be used later just invoke `+BUILD` Function
on the already prepared docs environment `+src` target which we have discussed before.

```Earthfile
Expand All @@ -93,7 +93,7 @@ local:
```

To finally build a docker image which is pretty strait forward process,
you should firstly invoke `+PACKAGE` UDC target which will prepare an environment for future docs image,
you should firstly invoke `+PACKAGE` Function which will prepare an environment for future docs image,
next step is to copy builded artifact from the previous step to `/usr/share/nginx/html` folder.
And the last step is to save a docker image with the specified name, tag and registry if it is needed.

Expand Down
16 changes: 8 additions & 8 deletions docs/src/guides/languages/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ deps:
# Any build dependencies should also be captured in this target.
RUN apk add --no-cache gcc musl-dev
# This UDC automatically copies the go.mod and go.sum files and runs
# This Function automatically copies the go.mod and go.sum files and runs
# `go mod download` to install the dependencies.
DO ../../earthly/go+DEPS --ginkgo="false"
```
Expand All @@ -75,11 +75,11 @@ This target is also going to build responsible for installing external build dep
These are dependencies that are not specific to a language and usually get installed system-wide.
In our case, since we're building a static binary, we need `gcc` and `musl`.

Finally, the actual logic we will be using is encapsulate in a UDC.
Finally, the actual logic we will be using is encapsulate in a Function.
This is a very common pattern, as an `Earthfile` can get repetitive across a repository.
In our case, we use the `go+DEPS` UDC that will automatically copy our `go.mod` and `go.sum` files and then execute
In our case, we use the `go+DEPS` Function that will automatically copy our `go.mod` and `go.sum` files and then execute
`go mod download`.
The UDC will also establish a cache for the Go tooling.
The Function will also establish a cache for the Go tooling.
This means that, even if our source code changes, we'll see a substantial speed boost when compiling because the cache is preserved
across Earthly runs.

Expand All @@ -96,10 +96,10 @@ check:
# This target checks the overall health of the source code.
FROM +src
# This UDC validates the code is formatted according to Go standards.
# This Function validates the code is formatted according to Go standards.
DO ../../earthly/go+FMT --src="go.mod go.sum cmd"
# This UDC runs golangci-lint to check for common errors.
# This Function runs golangci-lint to check for common errors.
DO ../../earthly/go+LINT --src="go.mod go.sum cmd"
```

Expand All @@ -111,8 +111,8 @@ Any future targets which need access to the source code will inherit from this t

Now that the source code is available, we can begin performing static checks.
These checks are intended to verify the code is healthy and conforms to a certain standard.
As we did in the previous section, here we rely on UDCs again to perform these checks.
These two UDCs will validate the code formatting is correct and also perform a series of lints to validate code quality.
As we did in the previous section, here we rely on Functions again to perform these checks.
These two Functions will validate the code formatting is correct and also perform a series of lints to validate code quality.

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.
Expand Down
8 changes: 4 additions & 4 deletions docs/src/guides/languages/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ builder:

The first target we are going to consider will be responsible to prepare a PostgreSQL environment (Earthly `+postgres-base` target),
migrations, migrations configuration and seed data (`COPY --dir ./migrations ./data ./refinery.toml .`),
doing some final build step (Earthly `+BUILDER` UDC target).
doing some final build step (Earthly `+BUILDER` Function).

In the next steps we are going to inheriting from this `+builder` target which contains all necessary data,
dependencies, environment to properly run PostgreSQL database.
Expand Down Expand Up @@ -92,8 +92,8 @@ These checks are intended to verify the code is healthy and well formatted to a
and done with the help of the `sqlfluff` tool which is already configured during the `+postgres-base` target.

To apply and fix some formatting issues you can run `+format` target which will picks up directory
where your Earthly file lies in as a source dir for formatting and run `+FORMAT` UDC target.
Under the hood `+FORMAT` UDC target runs `sqlfluff-image` docker image,
where your Earthly file lies in as a source dir for formatting and run `+FORMAT` Function.
Under the hood `+FORMAT` Function runs `sqlfluff-image` docker image,
which contains the same configuration and setup which is applied during the `+check`.

<!-- markdownlint-disable max-one-sentence-per-line -->
Expand All @@ -118,7 +118,7 @@ With the `*.sql` files validation out of the way, we can finally build our Postg
Since we need migration and seed data files,
we'll inherit from the `builder` target.
The actual image build process is pretty straight-forward
and fully defined under the `+BUILD` UDC target.
and fully defined under the `+BUILD` Function.
The only thing it is needed to specify is a few arguments:

* `tag` - the tag of the image, default value `latest`.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/guides/languages/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ so it is mandatory to have `pyproject.toml` and `poetry.lock` files in the root
The fist step of the `builder` target is prepare a Python environment
with poetry via `+python-base` target.
Next step is to copy source code of the project and finally finalize the build
with some poetry project setup which is done with `+BUILDER` UDC target.
with some poetry project setup which is done with `+BUILDER` Function.

### Running checks

Expand Down
Loading

0 comments on commit 2818e2d

Please sign in to comment.