swiftlang / swiftlang/github-workflows

Propagate custom env vars to the API checker soundness check

Open
#205 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
115
Forks
57
Avg merge
1d 8h
Merged PRs (30d)
3

Description

Propagate custom env vars to the API checker soundness check: https://github.com/swiftlang/github-workflows/blob/35713f899d13ad504c249ecff3fbf90c931c7bcb/.github/workflows/soundness.yml#L92

This is needed as we use env vars to enable all traits in most CI pipelines for packages that have any non-default package traits.

Setting this env on the workflow that calls this one doesn't seem to do the job, maybe they need to be propagated explicitly? That's what we do elsewhere: https://github.com/apple/swift-nio/blob/888f4affd6cc7629adace9492c95504dd5201ae1/.github/workflows/benchmarks.yml#L168

cc @rnro

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 with .github/workflows/soundness.yml at line 92 and inspect how the API checker soundness check is invoked. Compare its environment handling with swift-nio's .github/workflows/benchmarks.yml around line 168, then run the workflow with custom trait-enabling variables and confirm they reach the check.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.