rapidsai / rapidsai/shared-workflows

[FEA] Add build/run environment output as a separate step in build/test workflows

Open
#272 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
8
Forks
33
Avg merge
23h 51m
Merged PRs (30d)
19

Description

Often when CI fails during package upgrades it is because the dependencies are not yet up to date in the installed environment. Spotting this is sometimes complicated because either the test run script doesn't run the relevant command (conda list or pip freeze), or it's lost in installation/test run backtraces.

It would be nice if there were a step in the actions workflow that just ran conda list or pip freeze as a appropriate that we could expand as a step in the CI run.

I think it would have to run after the repository-provided test script (or else the workflows would have to split the "create environment" from the "run tests" phase).

We could do this ad-hoc in each repository's run script, but that doesn't give nice clicky sections in the CI run, and is easy to miss because it's not always in a consistent place.

Contributor guide

No contributing guide indexed for this repository

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 reading the reusable build/test workflows and the repository-provided test script entry points. Compare the conda and pip environment cases, then verify that the package listing runs after the test script in its own expandable CI step. Done means the relevant workflow runs conda list or pip freeze with the output visible separately.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.