Skip to content

Commit

Permalink
docs: Replace redhat-appstudio occurrences with konflux-ci
Browse files Browse the repository at this point in the history
Drop current container badge, which displays [container | none].
Let's replace it with something less confusing, for example:
[container | latest] and link to cachi2 image with the latest tag.

badge color: blue

Signed-off-by: Michal Šoltis <[email protected]>
  • Loading branch information
slimreaper35 committed Dec 18, 2024
1 parent 21a6845 commit c3f1594
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ and DNF server with `tests/dnfserver/start.sh &` to speed up the tests.
To run integration-tests with custom image, specify the CACHI2\_IMAGE environment variable. Examples:

```shell
CACHI2_IMAGE=quay.io/redhat-appstudio/cachi2:{tag} nox -s integration-tests
CACHI2_IMAGE=quay.io/konflux-ci/cachi2:{tag} nox -s integration-tests
CACHI2_IMAGE=localhost/cachi2:latest nox -s integration-tests
```

Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Cachi2

[![coverage][cachi2-coverage-badge]][cachi2-coverage-status]
[![container][cachi2-container-status]][cachi2-container]
[![container][cachi2-container-badge]][cachi2-container-status]

Cachi2 is a CLI tool that pre-fetches your project's dependencies to aid in making your build process
[hermetic](https://slsa.dev/spec/v0.1/requirements#hermetic).
Expand Down Expand Up @@ -61,18 +61,18 @@ To install Cachi2 for local development, see the [development](#development) sec

### Container image

[![container][cachi2-container-status]][cachi2-container]
[![container][cachi2-container-badge]][cachi2-container-status]

```text
quay.io/redhat-appstudio/cachi2:latest
quay.io/konflux-ci/cachi2:latest
```

The container is re-built automatically on every merge to the main branch.

You may wish to set up an alias to make local usage more convenient:

```shell
alias cachi2='podman run --rm -ti -v "$PWD:$PWD:z" -w "$PWD" quay.io/redhat-appstudio/cachi2:latest'
alias cachi2='podman run --rm -ti -v "$PWD:$PWD:z" -w "$PWD" quay.io/konflux-ci/cachi2:latest'
```

Note that the alias mounts the current working directory - the container will have access to files in that directory
Expand Down Expand Up @@ -260,8 +260,10 @@ still in early development phase.

[cachi2-coverage-badge]: https://codecov.io/github/containerbuildsystem/cachi2/graph/badge.svg?token=VJKRTZQBMY
[cachi2-coverage-status]: https://codecov.io/github/containerbuildsystem/cachi2
[cachi2-container]: https://quay.io/repository/redhat-appstudio/cachi2
[cachi2-container-status]: https://quay.io/repository/redhat-appstudio/cachi2/status

[cachi2-container-badge]: https://img.shields.io/badge/container-latest-blue
[cachi2-container-status]: https://quay.io/repository/konflux-ci/cachi2/tag/latest

[cachi2-releases]: https://github.com/containerbuildsystem/cachi2/releases
[sdist-spec]: https://packaging.python.org/en/latest/specifications/source-distribution-format/
[wheel-spec]: https://packaging.python.org/en/latest/specifications/binary-distribution-format/
Expand Down

0 comments on commit c3f1594

Please sign in to comment.