Skip to content
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.

CI: Add options to static-checks script #471

Conversation

jodh-intel
Copy link
Contributor

Add command-line options to all individual test functions in the static-checks.sh script to be run, rather than all of the tests.

Also includes commits for improved messages, and an explicit "skip" for the TODO/FIXME checker that was disabled on #464.

Fixes #470.

Signed-off-by: James O. D. Hunt james.o.hunt@intel.com

Remove a stray code comment from the static-check script.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Rather than using comments, display a message so the caller can see
whether some of the tests are running on `master` or their PR branch.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
The TODO/FIXME checker disabled on [1] needs an explicit skip message
pointing at an issue URL to ensure we don't forget to re-enable it.

---

[1] - kata-containers#464

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Display a message when the repository is detected automatically.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Rather than just display the usage, display an informational message so
the user knows they need to specify a repo URL.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add command-line options to all individual test functions in the
`static-checks.sh` script to be run, rather than all of the tests.

Fixes kata-containers#470.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add more examples to the usage statement for the static-checks script.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add a new "--force" option to override a skipped test. This is
currently only useful to force the TODO/FIXME checker to run.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Copy link
Contributor

@grahamwhaley grahamwhaley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm.
One note

usage()
{
cat <<EOT

Usage: $script_name help
$script_name repo-name [true]
$script_name [options] repo-name [true]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somewhere, but I don't know where, we should probably try and note in the help that if you do not supply any options, then the default is 'all'. I don't think that is listed anywhere in the help?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Explain in the usage statement for the static-checks script that all
tests will be run by default.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants