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

Tighten CI checks #107

Merged
merged 2 commits into from
Apr 2, 2024
Merged

Tighten CI checks #107

merged 2 commits into from
Apr 2, 2024

Conversation

PhilMiller
Copy link
Contributor

@PhilMiller PhilMiller commented Apr 2, 2024

We want to ensure code quality issues get caught relatively early, before they cause problems in ngen integration tests on updates.

Changes

  • Enable AddressSanitizer (ASan)
  • Build with -Werror (including -Og to get control/data-flow analysis for necessary warnings)
  • Stop smashing CMake options that the user may have set on the command line

Testing

  1. CI

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Linux
  • macOS

@PhilMiller
Copy link
Contributor Author

(to be rebased and merged after #106)

@PhilMiller PhilMiller marked this pull request as ready for review April 2, 2024 18:35
Copy link
Member

@aaraney aaraney left a comment

Choose a reason for hiding this comment

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

Thanks for improving CI! I doubt you removing the ability to specify the C and Cpp compilers Cmake uses via environment variables will affect anyone. But, just to be on the safe side will you please update the PR description to reflect that this is a potential breaking change to the build process and show how to fix this (e.g. -DCMAKE_C_COMPILER='gcc')?

@PhilMiller
Copy link
Contributor Author

It doesn't actually remove any ability. CMake already checks those environment variables, without anything in CMakeLists.txt

@PhilMiller
Copy link
Contributor Author

E.g. https://cmake.org/cmake/help/latest/envvar/CC.html

@PhilMiller PhilMiller merged commit 6d08db7 into master Apr 2, 2024
4 checks passed
@PhilMiller PhilMiller deleted the PhilMiller/tighten-CI branch April 2, 2024 19:00
@aaraney
Copy link
Member

aaraney commented Apr 2, 2024

The more you know. I knew it was at least conventional, didn't realize it was a feature. Thanks for the link!

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