quickwit-oss / quickwit-oss/quickwit

Docs-only PRs cannot be merge easily

Open
#2,114 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
11.7k
Forks
597
Avg merge
2d 22h
Merged PRs (30d)
37

Description

We added some optimization on the CI pipeline to trigger checks only when necessary.
While this is great and saves a lot of time, it's currently preventing PR that only changed the docs from being allowed to be merged even after approval.

Investigate (Github Action) to get the best of both worlds. That is have docs-only PRs to pass all checks that won't be triggered on them.

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

Review the GitHub Actions workflow conditions that determine which checks run for pull requests, focusing on the path filtering used for docs-only changes. Done means a pull request changing only documentation can pass all required checks, including checks that are skipped because they are not applicable, and merge after approval.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, devops
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.