Skip to content

Commit

Permalink
revert Readme.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr-Leshiy committed Nov 28, 2023
1 parent 294f936 commit 15873cb
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 1 deletion.
21 changes: 21 additions & 0 deletions earthly/docs/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Catalyst Documentation Builders and UDCs

This directory contains targets for the Catalyst Documentation builders, and associated UDCs.

## Check

This target includes a check to ensure the MkDocs base builder works as expected.

```bash
earthly -P +check
```

## Updating Dependencies

If a new dependency is added to `pyproject.toml` ensure to run:

```sh
poetry lock
```

in the `earthly/docs` directory to update the locked dependencies.
36 changes: 36 additions & 0 deletions earthly/python/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@

# Python Earthly Build Containers and UDCs

This repo defines common python targets and UDCs for use with python.

## User Defined Commands

### POETRY_SETUP

This UDC sets up a python based container that uses poetry for dependency management.
Once the UDC has run, the Earthly target that invoked it will

#### Invocation

In an `Earthfile` in your source repository add:

```Earthfile
example_python_target:
FROM python:3.11-bullseye
DO github.com/input-output-hk/catalyst-ci:v1.2.0/earthly/python+POETRY_SETUP
```

You may also pass optional arguments:

* `extra_files`: Defining extra files into the `/poetry` directory in the container.
* `opts`: Options to the `poetry install` command.

These arguments are optional and neither is required to be set.

The directory that contains the Earthfile that invokes this UDC MUST have:

* `pyproject.toml` : Definitions of the project to be installed with Poetry.
* `poetry.lock` : Dependency lock file.
Up-to-date by running:
* `poetry lock --no-update` : Update lock file, but do not update dependencies; or
* `poetry lock` : Update lock file and dependencies as required.
1 change: 0 additions & 1 deletion earthly/rust/Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ rust-base-all-hosts:
# * toolchain : The `rust-toolchain` toml file.
SETUP:
COMMAND

ARG toolchain=./rust-toolchain.toml

# Copy our toolchain dependency.
Expand Down

0 comments on commit 15873cb

Please sign in to comment.