Commit graph

10 commits

Author SHA1 Message Date
Jun Aruga
5a26dab025 README.md: Align the description with the CentOS Stream README.md.
Align the README.md description with the CentOS Stream README.md.
https://gitlab.com/redhat/centos-stream/tests/ruby/-/merge_requests/5
2026-02-25 18:51:25 +00:00
Jun Aruga
1d0f3c0da4 README: Add sending pull-requests section. 2026-01-29 13:30:38 +00:00
Jun Aruga
2c7759b5bc README.md: Add how to test with a rpms/ruby PR.
Note I used the `koji download-task` command rather than `koji download-build`,
because it seems the `koji download-build` doesn't work for scratch build.[1]

[1] https://pagure.io/koji/issue/4283
2026-01-29 13:26:43 +00:00
Jun Aruga
9df428e2d3 README.md: Limit lines to 80 characters.
Apply semantic line breaks [1] to the texts except for breaking markdown syntax.
The limitation of the 80 characters is inspired by Ruby Rubocop's style guide.
[2]

[1] https://sembr.org/
[2] https://github.com/rubocop/ruby-style-guide?tab=readme-ov-file#maximum-line-length
2026-01-29 13:26:36 +00:00
Jun Aruga
6c9722646b README.md: Replace tmt test ls with tmt tests ls.
According to the output by `tmt --help`, the `tmt tests` is an official command
name.

```
$ tmt --version
tmt version: 1.38.0

$ tmt --help
...
Commands:
...
  tests    Manage tests (L1 metadata).
...
```
2024-11-20 17:27:07 +01:00
Jun Aruga
1ec0f08fb7 README.md: Remove a part of the available integration tests.
There is no "bundler-unit-test" in the repository.
The actual test was dropped at the following commit in the past. But the README
was not updated.

https://src.fedoraproject.org/tests/ruby/c/831c7db845139a463762c80470f85a963832204d?branch=main

The listed tests by `tmt test ls` is good enough to show the information.
2024-11-20 17:13:05 +01:00
Lukáš Zachar
ec8759b052 Add a plan to run all the tests.
* Update the plan /plans/modified to run in CI. See the following link for the
  condition `trigger == commit`.
  https://tmt.readthedocs.io/en/stable/spec/context.html#trigger
* Add the plan /plans/all to run all the tests. The plan is not executed in CI
  as a default. Don't trigger this plan in CI to save the infra resource and
  the running time.
  Note we don't describe the triggered environment such as local or CI in the
  `summary` element in the plan /plans/all of the `plans.fmf`. Because this
  plan is executed as a default, and users can override the triggered
  environment by running the `tmt` with `trigger` option, such as
  `tmt -c trigger=commit`. We don't want to give users the impression that the
  plan only works in a specific running environment.
* Update the `README.md` removing the parts of the `plans --default` option in
  the `tmt run` commands that are not needed due to the plan /plans/all.

Co-authored-by: Lukáš Zachar <lzachar@redhat.com>
2024-10-08 14:48:43 +02:00
Jun Aruga
fa42fa7ad2 Update README adding how to run a specific test. 2024-10-01 18:10:24 +02:00
Jun Aruga
b90aa97120 Update README adding Contributing section.
* Add Contributing section including Testing sub section.
* Change the repository name's heading level.
  Replace the heading level 2 syntax ("--") with the more popular heading level
  1 syntax.
  See <https://www.markdownguide.org/basic-syntax/> for details.
2024-09-25 16:17:02 +02:00
Miroslav Vadkerti
06c18fa5a3 README.md: rename from README
Signed-off-by: Miroslav Vadkerti <mvadkert@redhat.com>
2018-02-15 13:49:51 +01:00
Renamed from README (Browse further)