Update directions for running CI tests.

[brett060102]

1: update section on .env file to reference .env-example and
match contents of .env-example

2: Included information from ./build/ci/README.md in top level README.md
and delete the file.

3: reword sections to avoid use of "you" and "your"

4: add information on yast test

[mssola]

Funnily enough, this is redundant to the main README.md as far as I can see. And, in fact, I like the wording much better there. Hence, maybe here we just need to reference the main README file? Or maybe just merge this file into the main README.md file? To be honest, I don't see why all of this has to be kept in separate files since the main README.md file is not that large to begin with 😄

[mssola]

I see why this is necessary but I'm left wondering why didn't this break before. As in, maybe these specific scripts (i.e. docker run) don't need this but feature tests actually do? If that is the case and only the last command (the one running build/ci/run-feature-tests) needs this, then I'd just add -w there, and before showing the command explicitly tell the reader about this and it might be unexpected.

[brett060102]

Without "-w /usr/src/connect-ng"
docker run --rm -it -v $(pwd):/usr/src/connect-ng $IMAGE 'build/ci/build-rpm' and
docker run --rm -it --env-file .env -v $(pwd):/usr/src/connect-ng $IMAGE bash -c 'build/ci/build-rpm && build/ci/configure && build/ci/run-feature-tests'

both fail:
$ docker run --rm -it --env-file .env -v $(pwd):/usr/src/connect-ng $IMAGE bash -c 'build/ci/build-rpm && build/ci/configure && build/ci/run-feature-tests'
bash: build/ci/build-rpm: No such file or directory
$ docker run --rm -it -v $(pwd):/usr/src/connect-ng $IMAGE 'build/ci/build-rpm'
docker: Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: error during container init: exec: "build/ci/build-rpm": stat build/ci/build-rpm: no such file or directory

Run 'docker run --help' for more information

The -w is not really needed for:
docker run --rm -it --env-file .env -v $(pwd):/usr/src/connect-ng $IMAGE

but without it you drop into the container in /go, which is not real useful.

I am guessing no one hit this because all of you know what to do, and used "make feature-tests" which I did not notice until you mentioned it. Thanks for pointing me at the top level RERADME. it is is also out of date. At least based on:
.github/workflows/features.yml: REGCODE: ${{ secrets.REGCODE }}
.github/workflows/features.yml: HA_REGCODE: ${{ secrets.HA_REGCODE }}
.github/workflows/features.yml: EXPIRED_REGCODE: ${{ secrets.EXPIRED_REGCODE }}

So, I will update the top level README as well. Then just tell me how you want the duplicate info handled.

[brett060102]

I have updated the top level README to match the build/ci/README there is duplicate information.
We can either leave the duplicate or update the top level README to point to build/ci/README.md

Based on:
ls .github/workflows/

There are three CI tests flows:
lint-unit.yml
make check-format
make test
make vendor build

features.yml
build/ci/build-rpm
build/ci/configure
build/ci/run-feature-tests

yast.yml
make test-yast

The only test not yet referenced in a README is check-format.

Do you want it added to either of the README's?

[mssola]

I would rather merge the one on ci into the top-level one, as that's most probably what's going to be read anyways. I'd like to avoid duplication whenever possible, and maybe having a README file inside of ci is not worth the hassle.

[brett060102]

@mssola I pulled info from build/ci/README.md into top level README and removed build/ci/README.md. Also did some minor edits to hopefully improve the flow.