atom-archive/xray

Help wanted: Continuous integration

Open

#22 opened on Mar 6, 2018

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Rust (8,531 stars) (248 forks)batch import
help wanted

Description

It would be great to get a PR helping us setup a CI build on Travis. This would also force us to iron out our build on Linux. It's not as simple as just slapping a travis.yml file into the root folder however...

Running only the tests that matter

We're planning on xray being a mono-repository to avoid the transaction costs and community fragmentation of hosting hundreds of separate, interconnected repos. However, it seems like this could make our builds horrible if we're not careful.

For this reason, even though we're versioning all these components together, we want their inter-dependencies to be clearly specified, and we want the global build script to be smart about knowing when to run which component's test suite.

So for example, if we make a change in xray_core, then we want to run tests on xray_node and xray_electron. A change to xray_electron should run tests only on xray_electron. A change to the documentation should run no tests.

How should we achieve this? We could cache some sort of fingerprint file on a per-module basis with a digest of the module's contents, plus make each module's build smart about checking the fingerprints of dependencies. Or maybe there's a better, standard way of dealing with this in mono-repos?

Contributor guide

Tech stack
rustjavascriptshell
Domain
devopsci cd
Issue type
devops
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with Travis CImonorepo build strategiesRust build toolchaindependency caching
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Investigate how to set up Travis CI for the xray monorepo. The issue discussion (https://github.com/atom archive/xray/issues/22) explores options like fingerprint caching for module dependencies. Look at existing monorepo CI setups (e.g., Bazel, Nx) and evaluate whether Travis workflows can conditionally run tests based on changed files. The key files to modify would be `.travis.yml` and possibly a custom build script in the root directory. Consider also integrating with a tool like `cargo make` for Rust specific testing.