mu2e/ci

GitHub comments-based interface to CI actions in Jenkins. Based on CMS-BOT.

Mu2e/CI

A GitHub bot (@FNALbuild) which handles continuous integration and testing workflows for the Mu2e Offline software. It is inspired by CMS-BOT.

Thanks to Patrick Gartung (@gartung), and the authors of CMS-BOT.

Development

pre-commit

This repository uses pre-commit and pre-commit.ci to enforce code style and fix problems. pre-commit.ci will push fixes automatically to branches and pull requests.

Running a check locally

You will need pre-commit.

pip install pre-commit

To install commit hooks,

pre-commit install

pre-commit will check everything before a git commit operation.

To run and apply fixes,

pre-commit run --all

ci's Issues

Properly support "test with" for mu2e_trig_config

Maybe this issue may require fixes in both this repo and Mu2e/codetools . I am not sure.

If you use the CI "test with" clause that includes a PR from mu2e_trig_config, it will work correctly but will generate an error message saying that there is no branch specified for the merge. It will then default to merging into HEAD, which is correct so long as we do not have other working branches in that repo. That is true for now but will not be in the medium term. For an example see:

Mu2e/Offline#1333 (comment)

The issue is to update the code in either CI and/or codetools to get the requested branch name and pass it to the section of codetools that uses it.

Add CI for EvtNtuple (a.k.a TrkAna)?

We'd like to have some CI for the EvtNtuple (Mu2e/TrkAna#23). I think all we need is a build test and a run test for each PR. How much work would this be both in terms of volume and difficulty?

Update logic controlling CI on PRs by non-authors

In process_pr near

CI/process_pr.py

Line 266 in 0f6a0d6

issue.create_comment(PR_AUTHOR_NONMEMBER)

rejects all CI requests if the author of the PR is not a member of the Mu2e GitHub organization. I would like to modify the logic to this:

1. Members of the team fnalbuild-users may request a CI job using the comment mechanism, regardless of the membership status of the author.
2. If the author of the PR is a member of the Mu2e GitHub organization,
   1. automatically run the CI at PR-create-time
   2. allow the author to request CI jobs using the comment mechanism
3. If the author of the PR is a non-member of the Mu2e GitHub organization:
   1. do not automatically run the CI at PR-create-time
   2. do not allow the author to request CI jobs using the comment mechanism

Add a force option

The CI refuses to rerun the CI if, since the last CI run, there are neither intervening commits on the PR not changes to the HEAD of the repo. This means that if there is an external issue, such as a change to mu2e_trig_config or the DB server going down, we cannot rerun the CI.

We should add syntax to the CI launch command that forces the CI to run even if it would be blocked by those tests. I think it's OK if anyone who can relaunch the CI can also use the force option.