ethereum-optimism / ethereum-optimism/optimism
Improve DevX in CircleCI config for job dependency references of reused job names
- Dominant language
- Go
- Stars
- 6.5k
- Forks
- 4k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 134
Description
CircleCI jobs that share the same name must include a CircleCI-assigned numeric suffix when referencing such a job as a dependency.
This was recently encountered when setting up the CI pipeline for `op-up` - [this PR](https://github.com/ethereum-optimism/optimism/pull/17033) got around the issue by setting unique names for the jobs that had the conflicting `contracts-bedrock-build` job name.
We should explore ways to improve the UX here. Some options:
* In https://github.com/ethereum-optimism/optimism/issues/17184 we'll aim to enable local testing of CircleCI configs - we could see if there is a way to configure this tool to at least issue a warning on these kinds of conflicting job dependency references
* We could add a linter on PRs that flags this as a warning
Contributor guide
Research direction
Start by reviewing issue #17184 and PR #17033 for the local CircleCI testing context and the conflicting job names. Determine whether the validation tool or a PR linter can warn when dependencies reference reused job names without the required numeric suffix. Done means a documented, working warning path is selected and demonstrated for this case.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100