DocOps / DocOps/issuer

Incorporate documentation command testing

Open
#36 0 comments 0 reactions 1 assignee Claimed by @briandominick View on GitHub
automation internal type:feature
Dominant language
Ruby
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Use the Sourcerer module (currently in ReleaseHx but to be released as its own gem) to test commands in the docs.

In .adoc files, add `[.testable]` role to literalblocks that are meant to be run exactly as displayed, in an environment that follows from the sequence of commands before it, assuming `bundle install` up front.

Then add to Rakefile a task `:readme_test` like those in [releasehx](/DocOps/releasehx/blob/main/Rakefile) and [releasehx-demo](/DocOps/releasehx-demo/blob/main/Rakefile) (neither yet updated as of time of this posting).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.