extension_workflow_rollout.rs

  1use gh_workflow::{
  2    Event, Expression, Job, Level, Run, Step, Strategy, Use, Workflow, WorkflowDispatch,
  3};
  4use indoc::formatdoc;
  5use indoc::indoc;
  6use serde_json::json;
  7
  8use crate::tasks::workflows::steps::CheckoutStep;
  9use crate::tasks::workflows::{
 10    extension_bump::{RepositoryTarget, generate_token},
 11    runners,
 12    steps::{self, NamedJob, named},
 13    vars::{self, StepOutput},
 14};
 15
 16const ROLLOUT_TAG_NAME: &str = "extension-workflows";
 17
 18pub(crate) fn extension_workflow_rollout() -> Workflow {
 19    let fetch_repos = fetch_extension_repos();
 20    let rollout_workflows = rollout_workflows_to_extension(&fetch_repos);
 21    let create_tag = create_rollout_tag(&rollout_workflows);
 22
 23    named::workflow()
 24        .on(Event::default().workflow_dispatch(WorkflowDispatch::default()))
 25        .add_env(("CARGO_TERM_COLOR", "always"))
 26        .add_job(fetch_repos.name, fetch_repos.job)
 27        .add_job(rollout_workflows.name, rollout_workflows.job)
 28        .add_job(create_tag.name, create_tag.job)
 29}
 30
 31fn fetch_extension_repos() -> NamedJob {
 32    fn get_repositories() -> (Step<Use>, StepOutput) {
 33        let step = named::uses("actions", "github-script", "v7")
 34            .id("list-repos")
 35            .add_with((
 36                "script",
 37                indoc::indoc! {r#"
 38                    const repos = await github.paginate(github.rest.repos.listForOrg, {
 39                        org: 'zed-extensions',
 40                        type: 'public',
 41                        per_page: 100,
 42                    });
 43
 44                    const filteredRepos = repos
 45                        .filter(repo => !repo.archived)
 46                        .map(repo => repo.name);
 47
 48                    console.log(`Found ${filteredRepos.length} extension repos`);
 49                    return filteredRepos;
 50                "#},
 51            ))
 52            .add_with(("result-encoding", "json"));
 53
 54        let filtered_repos = StepOutput::new(&step, "result");
 55
 56        (step, filtered_repos)
 57    }
 58
 59    let (get_org_repositories, list_repos_output) = get_repositories();
 60
 61    let job = Job::default()
 62        .runs_on(runners::LINUX_SMALL)
 63        .timeout_minutes(5u32)
 64        .outputs([("repos".to_owned(), list_repos_output.to_string())])
 65        .add_step(get_org_repositories);
 66
 67    named::job(job)
 68}
 69
 70fn rollout_workflows_to_extension(fetch_repos_job: &NamedJob) -> NamedJob {
 71    fn checkout_zed_repo() -> CheckoutStep {
 72        steps::checkout_repo()
 73            .with_full_history()
 74            .with_path("zed")
 75            .with_custom_name("checkout_zed_repo")
 76    }
 77
 78    fn checkout_extension_repo(token: &StepOutput) -> CheckoutStep {
 79        steps::checkout_repo()
 80            .with_custom_name("checkout_extension_repo")
 81            .with_token(token)
 82            .with_repository("zed-extensions/${{ matrix.repo }}")
 83            .with_path("extension")
 84    }
 85
 86    fn get_previous_tag_commit() -> (Step<Run>, StepOutput) {
 87        let step = named::bash(formatdoc! {r#"
 88            PREV_COMMIT=$(git rev-parse "{ROLLOUT_TAG_NAME}^{{commit}}" 2>/dev/null || echo "")
 89            if [ -z "$PREV_COMMIT" ]; then
 90                echo "::error::No previous rollout tag '{ROLLOUT_TAG_NAME}' found. Cannot determine file changes."
 91                exit 1
 92            fi
 93            echo "Found previous rollout at commit: $PREV_COMMIT"
 94            echo "prev_commit=$PREV_COMMIT" >> "$GITHUB_OUTPUT"
 95        "#})
 96        .id("prev-tag")
 97        .working_directory("zed");
 98
 99        let step_output = StepOutput::new(&step, "prev_commit");
100
101        (step, step_output)
102    }
103
104    fn get_removed_files(prev_commit: &StepOutput) -> (Step<Run>, StepOutput) {
105        let step = named::bash(formatdoc! {r#"
106            PREV_COMMIT="{prev_commit}"
107
108            if [ "${{{{ matrix.repo }}}}" = "workflows" ]; then
109                WORKFLOW_DIR="extensions/workflows"
110            else
111                WORKFLOW_DIR="extensions/workflows/shared"
112            fi
113
114            echo "Calculating changes from $PREV_COMMIT to HEAD for $WORKFLOW_DIR"
115
116            # Get deleted files (status D) and renamed files (status R - old name needs removal)
117            # Using -M to detect renames, then extracting files that are gone from their original location
118            REMOVED_FILES=$(git diff --name-status -M "$PREV_COMMIT" HEAD -- "$WORKFLOW_DIR" | \
119                awk '/^D/ {{ print $2 }} /^R/ {{ print $2 }}' | \
120                xargs -I{{}} basename {{}} 2>/dev/null | \
121                tr '\n' ' ' || echo "")
122
123            REMOVED_FILES=$(echo "$REMOVED_FILES" | xargs)
124
125            echo "Files to remove: $REMOVED_FILES"
126            echo "removed_files=$REMOVED_FILES" >> "$GITHUB_OUTPUT"
127        "#})
128        .id("calc-changes")
129        .working_directory("zed");
130
131        let removed_files = StepOutput::new(&step, "removed_files");
132
133        (step, removed_files)
134    }
135
136    fn sync_workflow_files(removed_files: &StepOutput) -> Step<Run> {
137        named::bash(formatdoc! {r#"
138            REMOVED_FILES="{removed_files}"
139
140            mkdir -p extension/.github/workflows
141            cd extension/.github/workflows
142
143            if [ -n "$REMOVED_FILES" ]; then
144                for file in $REMOVED_FILES; do
145                    if [ -f "$file" ]; then
146                        rm -f "$file"
147                    fi
148                done
149            fi
150
151            cd - > /dev/null
152
153            if [ "${{{{ matrix.repo }}}}" = "workflows" ]; then
154                cp zed/extensions/workflows/*.yml extension/.github/workflows/
155            else
156                cp zed/extensions/workflows/shared/*.yml extension/.github/workflows/
157            fi
158        "#})
159    }
160
161    fn get_short_sha() -> (Step<Run>, StepOutput) {
162        let step = named::bash(indoc::indoc! {r#"
163            echo "sha_short=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
164        "#})
165        .id("short-sha")
166        .working_directory("zed");
167
168        let step_output = StepOutput::new(&step, "sha_short");
169
170        (step, step_output)
171    }
172
173    fn create_pull_request(token: &StepOutput, short_sha: &StepOutput) -> Step<Use> {
174        let title = format!("Update CI workflows to `{short_sha}`");
175
176        named::uses("peter-evans", "create-pull-request", "v7")
177            .add_with(("path", "extension"))
178            .add_with(("title", title.clone()))
179            .add_with((
180                "body",
181                indoc::indoc! {r#"
182                    This PR updates the CI workflow files from the main Zed repository
183                    based on the commit zed-industries/zed@${{ github.sha }}
184                "#},
185            ))
186            .add_with(("commit-message", title))
187            .add_with(("branch", "update-workflows"))
188            .add_with((
189                "committer",
190                "zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>",
191            ))
192            .add_with((
193                "author",
194                "zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>",
195            ))
196            .add_with(("base", "main"))
197            .add_with(("delete-branch", true))
198            .add_with(("token", token.to_string()))
199            .add_with(("sign-commits", true))
200            .id("create-pr")
201    }
202
203    fn enable_auto_merge(token: &StepOutput) -> Step<gh_workflow::Run> {
204        named::bash(indoc::indoc! {r#"
205            PR_NUMBER="${{ steps.create-pr.outputs.pull-request-number }}"
206            if [ -n "$PR_NUMBER" ]; then
207                cd extension
208                gh pr merge "$PR_NUMBER" --auto --squash
209            fi
210        "#})
211        .add_env(("GH_TOKEN", token.to_string()))
212    }
213
214    let (authenticate, token) = generate_token(
215        vars::ZED_ZIPPY_APP_ID,
216        vars::ZED_ZIPPY_APP_PRIVATE_KEY,
217        Some(
218            RepositoryTarget::new("zed-extensions", &["${{ matrix.repo }}"]).permissions([
219                ("permission-pull-requests".to_owned(), Level::Write),
220                ("permission-contents".to_owned(), Level::Write),
221                ("permission-workflows".to_owned(), Level::Write),
222            ]),
223        ),
224    );
225    let (get_prev_tag, prev_commit) = get_previous_tag_commit();
226    let (calc_changes, removed_files) = get_removed_files(&prev_commit);
227    let (calculate_short_sha, short_sha) = get_short_sha();
228
229    let job = Job::default()
230        .needs([fetch_repos_job.name.clone()])
231        .cond(Expression::new(format!(
232            "needs.{}.outputs.repos != '[]'",
233            fetch_repos_job.name
234        )))
235        .runs_on(runners::LINUX_SMALL)
236        .timeout_minutes(10u32)
237        .strategy(
238            Strategy::default()
239                .fail_fast(false)
240                .max_parallel(10u32)
241                .matrix(json!({
242                    "repo": format!("${{{{ fromJson(needs.{}.outputs.repos) }}}}", fetch_repos_job.name)
243                })),
244        )
245        .add_step(authenticate)
246        .add_step(checkout_zed_repo())
247        .add_step(checkout_extension_repo(&token))
248        .add_step(get_prev_tag)
249        .add_step(calc_changes)
250        .add_step(sync_workflow_files(&removed_files))
251        .add_step(calculate_short_sha)
252        .add_step(create_pull_request(&token, &short_sha))
253        .add_step(enable_auto_merge(&token));
254
255    named::job(job)
256}
257
258fn create_rollout_tag(rollout_job: &NamedJob) -> NamedJob {
259    fn checkout_zed_repo(token: &StepOutput) -> CheckoutStep {
260        steps::checkout_repo().with_full_history().with_token(token)
261    }
262
263    fn update_rollout_tag() -> Step<Run> {
264        named::bash(formatdoc! {r#"
265            if git rev-parse "{ROLLOUT_TAG_NAME}" >/dev/null 2>&1; then
266                git tag -d "{ROLLOUT_TAG_NAME}"
267                git push origin ":refs/tags/{ROLLOUT_TAG_NAME}" || true
268            fi
269
270            echo "Creating new tag '{ROLLOUT_TAG_NAME}' at $(git rev-parse --short HEAD)"
271            git tag "{ROLLOUT_TAG_NAME}"
272            git push origin "{ROLLOUT_TAG_NAME}"
273        "#})
274    }
275
276    fn configure_git() -> Step<Run> {
277        named::bash(indoc! {r#"
278            git config user.name "zed-zippy[bot]"
279            git config user.email "234243425+zed-zippy[bot]@users.noreply.github.com"
280        "#})
281    }
282
283    let (authenticate, token) = generate_token(
284        vars::ZED_ZIPPY_APP_ID,
285        vars::ZED_ZIPPY_APP_PRIVATE_KEY,
286        Some(
287            RepositoryTarget::current()
288                .permissions([("permission-contents".to_owned(), Level::Write)]),
289        ),
290    );
291
292    let job = Job::default()
293        .needs([rollout_job.name.clone()])
294        .runs_on(runners::LINUX_SMALL)
295        .timeout_minutes(1u32)
296        .add_step(authenticate)
297        .add_step(checkout_zed_repo(&token))
298        .add_step(configure_git())
299        .add_step(update_rollout_tag());
300
301    named::job(job)
302}