Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ci: Add a CI to check documentation changes #943

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ci: Add a CI to check documentation changes #943

wants to merge 1 commit into from
+159 −0

Commits on May 13, 2024

  1. ci: Add a CI to check documentation changes 

    This fix introduces a new CI to check whether the command reference
documentations need to be updated.

When new commands or options are added, the
`finch gen-docs generate -p cmd/finch/` command should be run locally to
update the documentation.

However, it's easy to forget this step.

An issue has also been created that proposes to detect these differences.

- runfinch#942

Therefore, in this fix, the new CI step will generate the documentation
and compare it with the existing files.
If there are differences, the CI will fail, prompting contributors to
update the documentations.

Signed-off-by: Hayato Kiwata <[email protected]>
    @haytok
    haytok committed May 13, 2024
    Configuration menu
    Copy the full SHA
    b0f7b63 View commit details
    Browse the repository at this point in the history