Skip to content

Tests that verify documentation is up-to-date ignore subcommands #152

Open
@keynmol

Description

@keynmol

The subcommands docs were out of date because the tests only check the output of the tool as a whole, not individual subcommands: https://github.com/sourcegraph/scip/blob/main/cmd/main_test.go#L26

We should ideally check all of it.

Possible approaches:

  • Extend current one
  • Alternatively, generate the CLI.md entirely out of the tests and use git diff to see if it deviates from what is checked in. Like we do with snapshots

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions