NWChemEx / NWChemEx/.github

CI: skip source code build when only docs are modified

Open
#143 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

I think we should skip the source code build step in CI in a docs update PR (only files under docs/ are modified), and vice versa, skip the docs build step if no files under docs/ are modified. This is easy to implement: just adding conditions (whether (only) the files under docs/ have been modified?) to trigger the corresponding CI actions (source build or docs build).
Obviously these issues are not critical. We can fix them later.

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 by locating the CI workflow definitions and identify the source build and docs build steps. Verify the conditions with changes limited to docs/ and with changes outside docs/; done means each corresponding build runs only when its relevant files are modified.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.