Commit graph

21 commits

Author SHA1 Message Date
Wen Liang
a384d5bb50 docs(contributing): Add guide for running CI tests locally with tox-lsr
Signed-off-by: Wen Liang <liangwen12year@gmail.com>
2025-07-08 15:32:02 -06:00
Rich Megginson
bc339a17f4 ci: Add support for bootc end-to-end validation tests
NOTE: This also requires upgrading to tox-lsr 3.10.0, and some
hacks to workaround a podman issue in ubuntu.

These tests run the role during a bootc container image build, deploy
the container into a QEMU VM, boot that, and validate the expected
configuration there. They run in two different tox environments, and
thus have to be run in two steps (preparation in buildah, validation in
QEMU). The preparation is expected to output a qcow2 image in
`tests/tmp/TESTNAME/qcow2/disk.qcow2`, i.e. the output structure of
<https://github.com/osbuild/bootc-image-builder>.

There are two possibilities:

* Have separate bootc end-to-end tests. These are tagged with
`tests::bootc-e2` and are skipped in the normal qemu-* scenarios.
They run as part of the container-* ones.

* Modify an existing test: These need to build a qcow2 image exactly
*once* (via calling `bootc-buildah-qcow.sh`) and skip setup/cleanup
and role invocations in validation mode, i.e. when
`__bootc_validation` is true.

In the container scenario, run the QEMU validation as a separate step in
the workflow.

See https://issues.redhat.com/browse/RHEL-88396

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
2025-06-03 16:36:50 -06:00
Rich Megginson
d1083aa289 ci: get rid of integration tests - broken, unmaintained
The container based integration tests are broken and
unmaintained.  We don't need them anymore anyway.

If you want to run tests in a container, use tox-lsr.
https://github.com/linux-system-roles/tox-lsr?tab=readme-ov-file#container-testing

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
2025-05-19 15:56:13 -06:00
Sergei Petrosian
cd7eafe009
ci: Make badges consistent, run markdownlint all .md files (#631)
- Consistently generate badges for GH workflows in README RHELPLAN-146921
- Run markdownlint on all .md files
- Add custom-woke-action if not used already
- Use woke from linux-system-roles/lsr-woke-action

Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
2023-08-24 08:19:05 +02:00
Rich Megginson
fd92063502 docs: Consistent contributing.md for all roles - allow role specific contributing.md section
Provide a single, consistent contributing.md for all roles.  This mostly links to
and summarizes https://linux-system-roles.github.io/contribute.html

Allow for a role specific section which typically has information about
role particulars, role debugging tips, etc.

Fix several markdown consistency issues, other issues found by markdownlint
Use https://www.markdownguide.org/basic-syntax#alternate-syntax style for
headings, using `### heading3`, `#### heading4`, etc. for lower level
headings.

See https://github.com/linux-system-roles/.github/pull/19

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
2023-05-10 14:23:20 -06:00
Noriko Hosoi
f3078c256e Clean up / Workaround non-inclusive words
- CHANGELOG.md
- README.md
- contributing.md
- library/network_connections.py
- module_utils/network_lsr/argument_validator.py
- module_utils/network_lsr/ethtool.py
- tests/ensure_provider_tests.py
- tests/playbooks/tests_bond_options.yml
- tests/unit/test_network_connections.py

Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
2023-01-19 15:13:35 -07:00
Till Maas
83dcfdc346 Contributing: Explain how to install tox_lsr
Signed-off-by: Till Maas <opensource@till.name>
2022-03-11 15:43:51 +01:00
Till Maas
ac33851552 Contributing: Update IRC information
Signed-off-by: Till Maas <opensource@till.name>
2022-02-04 18:33:39 +01:00
Till Maas
adf4192e38 Contributing: Fix spelling
Signed-off-by: Till Maas <opensource@till.name>
2022-02-04 18:33:39 +01:00
Till Maas
b55d96a8a9 Add markdownlint style
Add a style for https://github.com/markdownlint/markdownlint/ to allow
it to be used to check for a consistent style and matching the current
style.

Signed-off-by: Till Maas <opensource@till.name>
2021-04-07 18:06:31 +02:00
Till Maas
ffa98f4876 Unify Markdown syntax
- Use a consistent style for lists and fix indentations
- Adjust whitespace to fence lists or code blocks
- Remove double blank lines
- Wrap lines at 88 characters
- Add missing notations for code
- Use proper links instead of plain URLs
- Reword some parts to fit the style and update the text

Signed-off-by: Till Maas <opensource@till.name>
2021-04-07 18:06:31 +02:00
Wen Liang
f01655c47a Add NetworkManager development documentation to contributing guide
Signed-off-by: Wen Liang <liangwen12year@gmail.com>
2020-12-18 17:54:56 +08:00
Fernando Fernandez Mancera
6812aab616 README.md: replace reference to "master" branch with "main" branch
All links containing references to the "master" branch must be replaced
by the "main" branch.

Signed-off-by: Fernando Fernandez Mancera <ffmancera@riseup.net>
2020-11-10 10:36:22 +01:00
Wen Liang
e92a5c272a Document where to find other images used for testing
Signed-off-by: Wen Liang <liangwen12year@gmail.com>
2020-10-07 22:31:17 +02:00
Wen Liang
eda49e3b38 Document running integration tests with podman
Document how to run integration test with podman, and list the files that are currently not working with podman.

Signed-off-by: Wen Liang <liangwen12year@gmail.com>
2020-09-15 19:52:09 +02:00
Wen Liang
d2bd928278 Remove extra quote in configuring git user email
Signed-off-by: Wen Liang <liangwen12year@gmail.com>
2020-09-15 19:52:09 +02:00
Rafael G. Ruiz
062b3a40ac contributing: add DCO requirement
Signed-off-by: Rafael G. Ruiz <llerrak@hotmail.com>
2020-08-28 09:10:43 +02:00
Till Maas
3fc15de068 Library: Introduce debug flags
Allow to disable the checkpoint feature with a debug flag to make
debugging easier.
2020-05-29 08:41:12 +02:00
Elvira Garcia Ruiz
c9d2f8f3b7 Update contributing.md with detailed info of the project
Now the contribution document has some steps to facilitate to get into the
project's workflow for new contributors. It also contains the code
structure and how to use the CI testing of the project and basic info about git
configuration. A small reference to the contributing document has been added to
the readme.

Signed-off-by: Elvira Garcia Ruiz <elviragr@riseup.net>
2020-05-27 13:59:49 +02:00
Harsh Jain
1359d963b0 Add the mailing list and IRC channel in contributing 2020-05-11 13:48:35 +02:00
Harsh Jain
9d561ea915 Add commit message guidelines to contributing 2020-04-26 17:03:57 +02:00