agama-project / agama / 11177307176

73%

Build Type

push

github

Committed by web-flow

Commit Message

feat(rust): add tasks using the xtask pattern (#1650)

While working on [Agama's website](https://agama-project.github.io/) we
wanted to include some documentation about the CLI. Fortunately,
[clap](https://crates.io/crates/clap) includes support for generating
markdown documentation, man pages, shell completions, etc.

After some research, we found out that the Rust community is adopting
the [xtask pattern](https://github.com/matklad/cargo-xtask), where you
write those tasks using Rust code. And it plays really well with clap,
as we can generate those artifcats from the sources.

However, we needed to do some refactoring to expose the CLI as a `lib`
crate so we can use it in our tasks.

This pull request includes the following tasks: `manpages`,
`completions` and `markdown`. The first step should be to take advantage
of them and generate the artifacts at runtime. It is open for discussion
whether we should do the same with the OpenAPI docs.

<details>
<summary>Generating the man pages</summary>

```shell
$ cargo xtask manpages                                                                                                                                                              at 15:05:46 
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
     Running `target/debug/xtask manpages`
Generate manpages documentation at out/man

$ ls out/man/                                                                                                                                                                       agama-auth-login.1
agama-auth-logout.1
agama-auth-show.1
agama-auth.1
agama-config-edit.1
agama-config-load.1
agama-config-show.1
agama-config.1
agama-download.1
agama-install.1
agama-logs-list.1
agama-logs-store.1
agama-logs.1
agama-probe.1
agama-profile-autoyast.1
agama-profile-evaluate.1
agama-profile-import.1
agama-profile-validate.1
agama-profile.1
agama-questions-answers.1
aga... (continued)

Run Details

0 of 102 new or added lines in 2 files covered. (0.0%)

1 existing line in 1 file now uncovered.

15640 of 22240 relevant lines covered (70.32%)

26.73 hits per line