Skip to content

Commit

Permalink
docs: Mention the usage of lighter bundle for builds (#1528)
Browse files Browse the repository at this point in the history
* docs: mention usage of lighter bundle for builds

* and fix some dead links

Signed-off-by: Dheeraj<[email protected]>

* docs: mention the repos used by e2e tests

* this would help users to know which repo
  they need to fork to their Org, in order
  to run the specific e2e test(s)

Signed-off-by: Dheeraj<[email protected]>

---------

Signed-off-by: Dheeraj<[email protected]>
  • Loading branch information
dheerajodha authored Mar 7, 2025
1 parent 81c5d7b commit ad297c9
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,16 +86,21 @@ are in the [infra-deployments](https://github.com/redhat-appstudio/infra-deploym
### Building and running the e2e tests

Most of the tests could require you to have specific container image repo's created (if you're using your own container image org/user account (`QUAY_E2E_ORGANIZATION`) or your own GitHub organization (`MY_GITHUB_ORG`).
In that case, before you run the test, make sure you have created
* `test-images` repo in quay.io, i.e. `quay.io/<QUAY_E2E_ORGANIZATION>/test-images` and make it **public** (this repo will be used for pushing container images produced by tests)
In that case, before you run the test, make sure you have
* created `test-images` repo in quay.io, i.e. `quay.io/<QUAY_E2E_ORGANIZATION>/test-images` and make it **public** (this repo will be used for pushing container images produced by tests)
* also make sure that the docker config, that is encoded in the value of `QUAY_TOKEN` environment variable, contains a correct credentials required to push to `test-images` repo. And make sure the robot account or user account has the **write** permissions set for `test-images` repo which is required by the tests to push the generated artifacts.
* fork following GitHub repositories to your org (specified in `MY_GITHUB_ORG` env var)
* forked following GitHub repositories to your org (specified in `MY_GITHUB_ORG` env var)
* https://github.com/redhat-appstudio-qe/devfile-sample-hello-world (for running build-service tests)
* https://github.com/redhat-appstudio-qe/hacbs-test-project (for konflux-demo test)
* https://github.com/redhat-appstudio-qe/strategy-configs (for konflux-demo test)
* https://github.com/redhat-appstudio-qe/konflux-test-integration (for integration test)
* https://github.com/redhat-appstudio-qe/konflux-test-integration-with-env (for integration-with-env test)
* https://github.com/redhat-appstudio-qe/group-snapshot-multi-component (for group-snapshots-tests test)
* https://gitlab.com/konflux-qe/hacbs-test-project-integration (for gitlab-integration-reporting test)
* https://github.com/redhat-appstudio-qe/konflux-test-integration-status-report (for status-reporting-to-pullrequest test)
* set the `CUSTOM_DOCKER_BUILD_PIPELINE_BUNDLE` environment variable
* this should point to a bundle that utilizes [buildah-min](https://github.com/konflux-ci/build-definitions/tree/main/task/buildah-min) for building images locally on small-sized clusters.
* The bundle is automatically created when you execute the `make local/cluster/prepare` command, and the corresponding command is displayed in the logs at the end.

Note: All Environments used in all e2e-tests are in [default.env](../default.env) file. In case you need to run a specific tests, not all environments are necessary to be defined.

Expand All @@ -122,8 +127,8 @@ The `e2e-appstudio` command is the root command that executes all test functiona
```
**NOTE**: The binary must be updated by running `make build` every time there are new changes in the tests.

The instructions for every test suite can be found in the [tests folder](tests), e.g. [has Readme.md](tests/konflux-demo/README.md).
You can also specify which tests you want to run using [labels](docs/LabelsNaming.md) or [Ginkgo Focus](docs/DeveloperFocus.md).
The instructions for every test suite can be found in the [tests folder](/tests/), e.g. [konflux-demo README.md](/tests/konflux-demo/README.md).
You can also specify which tests you want to run using [labels](LabelsNaming.md) or [Ginkgo Focus](DeveloperFocus.md).


# Konflux in Openshift CI and branch pairing
Expand Down

0 comments on commit ad297c9

Please sign in to comment.