Skip to content

[GitHub Actions] Don't run tests or docker build if the only changes are to markdown files#12787

Merged
tdonohue merged 1 commit into
DSpace:mainfrom
tdonohue:skip_markdown
Jul 17, 2026
Merged

[GitHub Actions] Don't run tests or docker build if the only changes are to markdown files#12787
tdonohue merged 1 commit into
DSpace:mainfrom
tdonohue:skip_markdown

Conversation

@tdonohue

@tdonohue tdonohue commented Jul 2, 2026

Copy link
Copy Markdown
Member

References

Description

This small PR updates our GitHub actions to skip running any tests (both Unit and Integration) or Docker builds when a PR or commit only includes changes to Markdown files (*.md).

The reason for this PR is to streamline our ability to update Markdown files without triggering CI, e.g. with #12739

Known Side Effect:

While this will ensure that we don't unnecessarily run tests/builds, disabling these checks will mean that PRs which only modify Markdown (*.md) will never receive a green checkmark from GitHub checks (as some checks will never complete).

You can see an example of this "side effect" in #12739, which doesn't have a green checkmark as the CodeQL task is flagged as Expected -- Waiting for status to be reported. In this situation, CodeQL will never run for PRs which only modify Markdown as it already has paths-ignore rules in codescan.yml, see https://github.com/DSpace/DSpace/blob/main/.github/workflows/codescan.yml#L20

(Personally, I'm OK with this side effect as it seems minor, but I wanted to make sure others agree.)

Instructions for Reviewers

  • Review the changes & verify that you are aware of the side effects listed above.

If approved, this should be ported to DSpace/dspace-angular, as it should similarly ignore PRs that only include changes to Markdown files.

@tdonohue tdonohue added this to the 11.0 milestone Jul 2, 2026
@tdonohue tdonohue added code task Code cleanup task 1 APPROVAL pull request only requires a single approval to merge. labels Jul 2, 2026
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 11.0 Release Jul 2, 2026
@paulo-graca
paulo-graca self-requested a review July 16, 2026 14:33

@paulo-graca paulo-graca left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you, @tdonohue!

I have a few more suggestions below. What do you think?

That said, the PR, as is, it's a +1 from me.

Comment thread .github/workflows/build.yml
@marsaoua
marsaoua requested a review from paulo-graca July 16, 2026 15:17
@tdonohue
tdonohue requested a review from marsaoua July 16, 2026 21:49
@tdonohue tdonohue added port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release port to dspace-10_x This PR needs to be ported to `dspace-10_x` branch for next bug-fix release labels Jul 16, 2026

@marsaoua marsaoua left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

+1

@marsaoua

Copy link
Copy Markdown
Contributor

Note: If ported to DSpace/dspace-angular, .vscode should maybe excluded as well.

@tdonohue

Copy link
Copy Markdown
Member Author

Merging & porting to all active branches. Will also manually port to dspace-angular.

@tdonohue
tdonohue merged commit 968d982 into DSpace:main Jul 17, 2026
27 checks passed
@github-project-automation github-project-automation Bot moved this from 🙋 Needs Reviewers Assigned to ✅ Done in DSpace 11.0 Release Jul 17, 2026
@dspace-bot

Copy link
Copy Markdown
Contributor

Git push to origin failed for dspace-8_x with exitcode 1

@dspace-bot

Copy link
Copy Markdown
Contributor

Git push to origin failed for dspace-9_x with exitcode 1

@dspace-bot

Copy link
Copy Markdown
Contributor

Git push to origin failed for dspace-10_x with exitcode 1

@tdonohue tdonohue removed port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release port to dspace-10_x This PR needs to be ported to `dspace-10_x` branch for next bug-fix release labels Jul 17, 2026
@tdonohue
tdonohue deleted the skip_markdown branch July 17, 2026 16:07
@tdonohue

Copy link
Copy Markdown
Member Author

Ported to frontend repository in DSpace/dspace-angular#5966

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge. code task Code cleanup task

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

4 participants