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

Add TODO/FIXME CI test  #444

@jodh-intel

Description

@jodh-intel

TODO and FIXME comments in the code tend to sit there and not get fixed. Much better that rather than such comments we have a reference to an issue that explains the problem properly.

An issue provides greater visibility thus maximising the chance the problem will be resolved.

Since we already screen for such comments in manual code review, why not automate it?

The plan is to fail a PR if it contains such a comment iff there is no associated issue URL with it.

Like other similar CI checks, this will be added to https://github.com/kata-containers/tests/blob/master/.ci/static-checks.sh and will only fail the CI run if the user modifies a file containing such a comment. If the CI is run on master, any such comments will cause a failure.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions