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

Feat: Additional Github Workflow Actions #37

Open
wants to merge 42 commits into
base: develop
Choose a base branch
from

Conversation

henry-wallace-phys
Copy link
Contributor

@henry-wallace-phys henry-wallace-phys commented Jan 25, 2025

Pull request description:

Ports more workflows from T2K/Core MaCh3

Changes or fixes:

  • Weekly code QL testing
  • Linter
  • More pedantic PR Title checking (feat/breaking/bugfix/tidy/core_update)

Landmine Check

https://github.com/tylermurry/github-pr-landmine/tree/master

Lets you check if a suggested code modification in a PR will just break the CI without needing to download the entire codebase!

Notes:

Branched off of doxygen PR so requires that pulled in first. As these actions are supplementary I've kept the PRs separate

Henry Wallace and others added 30 commits January 24, 2025 08:36
[resolving merge conflict broke CMakeLists, hopefully this patches it]
@henry-wallace-phys henry-wallace-phys changed the title Additional Github Workflow Actions Feat: Additional Github Workflow Actions Jan 27, 2025
Copy link
Contributor Author

@henry-wallace-phys henry-wallace-phys left a comment

Choose a reason for hiding this comment

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

Remove landmine action as repository was out of date

Copy link
Member

@dbarrow257 dbarrow257 left a comment

Choose a reason for hiding this comment

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

Comments

VALIDATE_PYTHON: true # Enable Python linting
VALIDATE_ALL_CODEBASE: true # Lint the entire codebase
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub token for permissions
# DISABLE_LINTERS: "CPP" # Disable linting for other languages
Copy link
Member

Choose a reason for hiding this comment

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

Can we really get away with the CPP linter enabled? I guess you've dealt with this by including the continue-on-error true? I think it's more useful to disable the CPP linter and require errors on YAML to be fixed

Copy link
Member

Choose a reason for hiding this comment

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

Like for example, you can see a YAML error here: https://github.com/DUNE/MaCh3_DUNE/actions/runs/13117147270/job/36594095657#step:4:939

To me, it's more important that we catch these YAML errors and have the bot fail

find_package(MaCh3 1.3.5 EXACT QUIET)

# KS: Here we try to find tag matching tutorial version. If we can't find one then use develop
# This will allow to grab tutorial for tagged MaCh3 version without a need of manually changing version
Copy link
Member

Choose a reason for hiding this comment

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

Is this really an upgrade?

It's now requiring two strings to be updated anytime we update core version - I don't think there's any new feature here?

Copy link
Member

Choose a reason for hiding this comment

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

I guess it's related to the flexible core update - but I don't know if that's really a good thing to support - need more discussion

@@ -17,6 +19,10 @@ RUN git checkout ${MACH3_DUNE_VERSION}
RUN mkdir -p ${MACH3_DUNE_INSTALL_DIR}
WORKDIR ${MACH3_DUNE_INSTALL_DIR}

RUN cmake ../
RUN if [ -n "$MACH3_CORE_VERSION" ]; then \
Copy link
Member

Choose a reason for hiding this comment

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

I think this is also potentially going to lead to issues - typically, the DUNE code is only supportable against a particular tag of core. It's not guaranteed that a snapshot of the DUNE code can be used against any core version. We also want to make sure that for reproducibility, the tag of core in the CMakeLists.txt is the one that is actually used

@@ -0,0 +1,248 @@
@article{gelman1996posterior,
Copy link
Member

Choose a reason for hiding this comment

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

Again, I don't know if we actually need this

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