NWChemEx / NWChemEx/.github

Add Required Tests to Branch Protection Rules

Open
#10 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dockerfile
Stars
1
Forks
2
Avg merge
22m
Merged PRs (30d)
4

Description

In theory every repo in the NWChemEx-Project organization has branch protection rules setup for the master branch (requires PRs, PRs need reviews, etc.). At one point we also specified via the GitHub API which CI workflows were required to pass before the PR is merged (for the record, all of the CI workflows need to pass before a PR should be merged). By specifying the required workflows as part of the branch protection rules, GitHub prevents us from accidentally merging a PR with failing workflows. Right now all of the workflows run, but if you're not careful, you can actually merge the PR with failing workflows.

In setting the required workflows, GitHub uses the names of the workflows. The problem previously was that somehow the names changed and so GitHub was waiting forever for non-existent workflows to run. To avoid the PRs being in limbo we dropped the required workflows. This issue is for resetting the branch protection rules so that they enforce the workflows passing using their current names (and hopefully figuring out a way to future proof the names so we don't have to go through this again).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the organization's current branch protection rules and the GitHub API configuration. Compare the required workflow names with the workflows currently running in the repositories, then restore requirements for all CI workflows. Done means pull requests cannot merge while any current CI workflow is failing, without waiting for obsolete workflow names.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, github-actions
Domain
ci-cd, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.