Skip to content

Commit

Permalink
Merge pull request containers#16586 from cevich/fix_contributing
Browse files Browse the repository at this point in the history
[CI:DOCS] Remove broken gate-container docs
  • Loading branch information
openshift-merge-robot authored Dec 5, 2022
2 parents a9c1fe2 + 190bab5 commit b26d4fc
Showing 1 changed file with 1 addition and 43 deletions.
44 changes: 1 addition & 43 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,49 +309,7 @@ podman build -t gate -f contrib/gate/Dockerfile .

***N/B:*** **don't miss the dot (.) at the end, it's really important**

#### Local use of gate container

The gate container's entry-point executes 'make' by default, on a copy of
the repository made at runtime. This avoids the container changing or
leaving build artifacts in your hosts working directory. It also guarantees
every execution is based upon pristine code provided from the host.

Execution does not require any special permissions from the host. However,
your Podman repository clone's root must be bind-mounted to the container at
'/usr/src/libpod'. The copy will be made into /var/tmp/go (`$GOSRC` in container)
before running your make target. For example, running `make lint` from a
repository clone at $HOME/devel/podman could be done with the commands:

```bash
$ cd $HOME/devel/podman
$ podman run -it --rm -v $PWD:/usr/src/libpod:ro \
--security-opt label=disable quay.io/libpod/gate:master \
lint
```

***N/B:*** Depending on your clone's git remotes-configuration,
(esp. for `validate` and `lint` targets), you may also need to reference the
commit which was your upstream fork-point. Otherwise you may receive an error
similar to:

```
fatal: Not a valid object name master
Makefile:152: *** Required variable EPOCH_TEST_COMMIT value is undefined, whitespace, or empty. Stop.
```

For example, assuming your have a remote called `upstream` running the
validate target should be done like this:

```bash
$ cd $HOME/devel/podman
$ git remote update upstream
$ export EPOCH_TEST_COMMIT=$(git merge-base upstream/master HEAD)
$ podman run -it --rm -e EPOCH_TEST_COMMIT -v $PWD:/usr/src/libpod:ro \
--security-opt label=disable quay.io/libpod/gate:master \
validate
```

### Integration and Other Tests
### Integration Tests

Our primary means of performing integration testing for Podman is with the
[Ginkgo](https://github.com/onsi/ginkgo) BDD testing framework. This allows
Expand Down

0 comments on commit b26d4fc

Please sign in to comment.