Skip to content

Commit 6a7721d

Browse files
committed
Apply review comments
1 parent 5d21fb4 commit 6a7721d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/ci/citool/src/main.rs

+7-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const CI_DIRECTORY: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/..");
1010
const DOCKER_DIRECTORY: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/../docker");
1111
const JOBS_YML_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/../github-actions/jobs.yml");
1212

13-
/// Representation of a job loaded from the jobs.yml file.
13+
/// Representation of a job loaded from the `src/ci/github-actions/jobs.yml` file.
1414
#[derive(serde::Deserialize, Debug, Clone)]
1515
struct Job {
1616
/// Name of the job, e.g. mingw-check
@@ -86,7 +86,10 @@ fn load_job_db(path: &Path) -> anyhow::Result<JobDatabase> {
8686
/// Representation of a job outputted to a GitHub Actions workflow.
8787
#[derive(serde::Serialize, Debug)]
8888
struct GithubActionsJob {
89+
/// The main identifier of the job, used by CI scripts to determine what should be executed.
8990
name: String,
91+
/// Helper label displayed in GitHub Actions interface, containing the job name and a run type
92+
/// prefix (PR/try/auto).
9093
full_name: String,
9194
os: String,
9295
env: HashMap<String, String>,
@@ -277,7 +280,9 @@ fn calculate_job_matrix(
277280
RunType::AutoJob => "auto",
278281
};
279282

280-
eprintln!("Output:\njobs={jobs:?}\nrun_type={run_type}");
283+
eprintln!("Output");
284+
eprintln!("jobs={jobs:?}");
285+
eprintln!("run_type={run_type}");
281286
println!("jobs={}", serde_json::to_string(&jobs)?);
282287
println!("run_type={run_type}");
283288

0 commit comments

Comments
 (0)