Skip to content
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.

Sign up for GitHub

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

README.md and CONTRIBUTING.md minor improvements #829

Merged
merged 3 commits into from
Feb 11, 2025
+11 −25
Merged

README.md and CONTRIBUTING.md minor improvements #829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2a0512
docs: Remove reference to Cachito package managers
slimreaper35 Feb 10, 2025
aa536db
docs: Remove invalid links and references
slimreaper35 Feb 6, 2025
2235854
docs: Remove duplicate 'Generating new test data' sections
slimreaper35 Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,12 @@ Example:
hack/mock-unittest-data/gomod.sh
```

To generate new data (output, dependencies checksums, vendor checksums) and run integration tests with them:

```shell
nox -s generate-test-data
```

Generate data for test cases matching a pytest pattern:

```shell
Expand Down Expand Up @@ -249,20 +255,6 @@ CACHI2_IMAGE=quay.io/konflux-ci/cachi2:{tag} nox -s integration-tests
CACHI2_IMAGE=localhost/cachi2:latest nox -s integration-tests
```

#### Generating new test data

To re-generate new data (output, dependencies checksums, vendor checksums) and run integration tests with them:

```shell
nox -s generate-test-data
```

Generate data for test cases matching a pytest pattern:

```shell
nox -s generate-test-data -- -k test_e2e_gomod
```

### Adding new dependencies to the project

Sometimes when working on adding a new feature you may need to add a new dependency to the project.
Expand All @@ -281,11 +273,11 @@ nox -s pip-compile

## Releasing

To release a new version of Cachi2, simply create a [GitHub release][cachi2-releases]. Note that
Cachi2 follows [semantic versioning](https://semver.org/) rules.
To release a new version of Cachi2, simply create a [GitHub release](https://github.com/hermetoproject/cachi2/releases).
Note that Cachi2 follows [semantic versioning](https://semver.org/) rules.
eskultety marked this conversation as resolved.
Show resolved Hide resolved

Upon release, the [.tekton/release.yaml](.tekton/release.yaml) pipeline tags the corresponding
[Cachi2 image][cachi2-container] with the newly released version tag (after validating that the
image with the newly released version tag (after validating that the
tag follows the expected format: `$major.$minor.$patch`, without a `v` prefix).

*You apply a release tag to a specific commit. The [.tekton/push.yaml](.tekton/push.yaml) pipeline
Expand Down
10 changes: 2 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ The primary intended use of Cachi2's outputs is for network-isolated container b
* [Installation](#installation)
* [Basic usage](#basic-usage)
* [Configuration](#configuration)
* [Releasing](#releasing)
* [Package managers](#package-managers)
* [Project status](#project-status)
* [Contributing](CONTRIBUTING.md)
Expand Down Expand Up @@ -57,7 +56,7 @@ technologies - such as containers - to achieve isolation (see [usage](docs/usage

We do not distribute Cachi2 as a standalone package as of now.

To install Cachi2 for local development, see the [development](#development) section.
To install Cachi2 for local development, see the [CONTRIBUTING.md](CONTRIBUTING.md).

### Container image

Expand Down Expand Up @@ -143,9 +142,6 @@ Planned:
* dnf
* cargo

*Based on the [supported package managers](https://github.com/containerbuildsystem/cachito#package-managers) in the
original Cachito.*

### gomod

<https://go.dev/ref/mod>
Expand Down Expand Up @@ -251,16 +247,14 @@ See [docs/generic.md](docs/generic.md) for more details.

## Project status

Cachi2 was derived (but is not a direct fork) from [Cachito](https://github.com/containerbuildsystem/cachito) and is
still in early development phase.
Cachi2 was derived (but is not a direct fork) from [Cachito](https://github.com/containerbuildsystem/cachito).

[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-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/
[setuppy-discouraged]: https://setuptools.pypa.io/en/latest/userguide/quickstart.html#setuppy-discouraged
Expand Down
Loading