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.

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

Allow warnings without an associated fence #98

Conversation

Adjective-Object
Copy link
Collaborator

This is because when running as a git commit hook we frequently run into
issues that we want to report to the user but do not want to fail the
build, which are not associated with a specific build.

For example:

  • As part of incremental checks, we impose a maximum file limit
    so that the incremental check on commits (e.g. large merges) does
    not run for multiple minutes. This leaves open the option to opt into
    a full check without blocking commits.
    When the incremental check would exceed the maximum check limit, we
    want to warn the user that the check is not happening, but not exit
    with 1, as it would fail precommit hooks.
  • When a partial check cannot be calculated from git, we abort early and
    do not perform checks for the same reason as above
  • When performing partial checks but there are no changes from
    git in source or fence files, we skip validation. We want to warn
    users about this because they may be running the program manually and
    not running it over the set of files they think they are running it
    over.

This is because when running as a git commit hook we frequently run into
issues that we want to report to the user but do not want to fail the
build, which are not associated with a specific build. For example:
- As part of incremental checks, we impose a maximum file limit
  so that the incremental check on commits (e.g. large merges) does
  not run for multiple minutes. This leaves open the option to opt into
  a full check without blocking commits.
  When the incremental check would exceed the maximum check limit, we
  want to warn the user that the check is not happening, but not exit
  with 1, as it would fail precommit hooks.
- When a partial check cannot be calculated from git, we abort early and
  do not perform checks for the same reason as above
- When performing partial checks but there are no changes from
  git in source or fence files, we skip validation. We want to warn
  users about this because they may be running the program manually and
  not running it over the set of files they think they are running it
  over.
@Adjective-Object Adjective-Object changed the title Make fences optional when reporting warnings Allow warnings without an associated fence Aug 6, 2021
@smikula smikula merged commit 8e7799d into smikula:master Aug 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants