lints workflow : feature or crate selection
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github-actions, rust
- Domain
- build-system, ci-cd
Research direction
Start by reading .github/workflows/lints.yml in ci-workflows, the gbench/Cargo.toml feature definition, and the referenced PR #255. Compare how the doc step invokes the lint crate and determine which crate or feature-selection behavior should be supported. Done means the workflow can handle the documented crate and feature-selection cases without failing on unsupported default features.
Written by the indexing model from the issue text.
Description
Documenting an issue encountered in https://github.com/lurk-lab/neptune/pull/255, which is arguably the fault of the crate organization:
- the gbench crate (which is non-publish!) runs with the default opencl feature, which does not compile on some CI machines:
https://github.com/lurk-lab/neptune/blob/main/gbench/Cargo.toml#L25 - the lint crate runs with
workspacein the doc step of the job:
https://github.com/lurk-lab/neptune/actions/runs/7294189991/job/19878612122?pr=255
https://github.com/lurk-lab/ci-workflows/blob/96e567fa741858807c1de28bb4d8194291faecfb/.github/workflows/lints.yml#L49
Three ways to solve this:
- make the gbench feature non-default, just generate a runtime panic if neither of opencl nor cuda are active,
- allow excluding a crate from the doc test,
- allow excluding a feature (or running with default-deatures = false) from the doc test,
- Dominant language
- No language data
- Stars
- 0
- Forks
- 3
- Avg merge
- 59m
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from argumentcomputer/ci-workflows
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
All issues in argumentcomputer/ci-workflows
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
priority: p3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
googleapis/librarian#7636 ·
-
package-update
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
oSoWoSo/vOid_Community_repOsitory#147 · 1 comment ·
-
Builders
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100