extension_auto_bump.rs

  1use gh_workflow::{
  2    Event, Expression, Input, Job, Level, Permissions, Push, Strategy, UsesJob, Workflow,
  3};
  4use indoc::indoc;
  5use serde_json::json;
  6
  7use crate::tasks::workflows::{
  8    extensions::WithAppSecrets,
  9    run_tests::DETECT_CHANGED_EXTENSIONS_SCRIPT,
 10    runners,
 11    steps::{self, CommonJobConditions, NamedJob, named},
 12    vars::{StepOutput, one_workflow_per_non_main_branch},
 13};
 14
 15/// Generates a workflow that triggers on push to main, detects changed extensions
 16/// in the `extensions/` directory, and invokes the `extension_bump` reusable workflow
 17/// for each changed extension via a matrix strategy.
 18pub(crate) fn extension_auto_bump() -> Workflow {
 19    let detect = detect_changed_extensions();
 20    let bump = bump_extension_versions(&detect);
 21
 22    named::workflow()
 23        .add_event(
 24            Event::default().push(
 25                Push::default()
 26                    .add_branch("main")
 27                    .add_path("extensions/**")
 28                    .add_path("!extensions/test-extension/**")
 29                    .add_path("!extensions/workflows/**")
 30                    .add_path("!extensions/*.md"),
 31            ),
 32        )
 33        .concurrency(one_workflow_per_non_main_branch())
 34        .add_job(detect.name, detect.job)
 35        .add_job(bump.name, bump.job)
 36}
 37
 38fn detect_changed_extensions() -> NamedJob {
 39    let preamble = indoc! {r#"
 40        COMPARE_REV="$(git rev-parse HEAD~1)"
 41        CHANGED_FILES="$(git diff --name-only "$COMPARE_REV" "$GITHUB_SHA")"
 42    "#};
 43
 44    let filter_newly_added = indoc! {r#"
 45        # Filter out newly added extensions
 46        FILTERED="[]"
 47        for ext in $(echo "$EXTENSIONS_JSON" | jq -r '.[]'); do
 48            if git show HEAD~1:"$ext/extension.toml" >/dev/null 2>&1; then
 49                FILTERED=$(echo "$FILTERED" | jq -c --arg e "$ext" '. + [$e]')
 50            fi
 51        done
 52        echo "changed_extensions=$FILTERED" >> "$GITHUB_OUTPUT"
 53    "#};
 54
 55    let script = format!(
 56        "{preamble}{detect}{filter}",
 57        preamble = preamble,
 58        detect = DETECT_CHANGED_EXTENSIONS_SCRIPT,
 59        filter = filter_newly_added,
 60    );
 61
 62    let step = named::bash(script).id("detect");
 63
 64    let output = StepOutput::new(&step, "changed_extensions");
 65
 66    let job = Job::default()
 67        .with_repository_owner_guard()
 68        .runs_on(runners::LINUX_SMALL)
 69        .timeout_minutes(5u32)
 70        .add_step(steps::checkout_repo().with_custom_fetch_depth(2))
 71        .add_step(step)
 72        .outputs([("changed_extensions".to_owned(), output.to_string())]);
 73
 74    named::job(job)
 75}
 76
 77fn bump_extension_versions(detect_job: &NamedJob) -> NamedJob<UsesJob> {
 78    let job = Job::default()
 79        .needs(vec![detect_job.name.clone()])
 80        .cond(Expression::new(format!(
 81            "needs.{}.outputs.changed_extensions != '[]'",
 82            detect_job.name
 83        )))
 84        .permissions(
 85            Permissions::default()
 86                .contents(Level::Write)
 87                .issues(Level::Write)
 88                .pull_requests(Level::Write)
 89                .actions(Level::Write),
 90        )
 91        .strategy(
 92            Strategy::default()
 93                .fail_fast(false)
 94                // TODO: Remove the limit. We currently need this to workaround the concurrency group issue
 95                // where different matrix jobs would be placed in the same concurrency group and thus cancelled.
 96                .max_parallel(1u32)
 97                .matrix(json!({
 98                    "extension": format!(
 99                        "${{{{ fromJson(needs.{}.outputs.changed_extensions) }}}}",
100                        detect_job.name
101                    )
102                })),
103        )
104        .uses_local(".github/workflows/extension_bump.yml")
105        .with(
106            Input::default()
107                .add("working-directory", "${{ matrix.extension }}")
108                .add("force-bump", false),
109        )
110        .with_app_secrets();
111
112    named::job(job)
113}