Skip to content

Migrate generate-automation.js to js-yaml 5 #122

Description

@rtibblesbot

❌ This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.

Overview

Dependabot PR #118 bumps the js-yaml devDependency from 4.1.0 to 5.5.0 and was closed unmerged: under 5.x, scripts/generate-automation.js emits different YAML, so the generate-automation prek hook (node scripts/generate-automation.js --check) fails on all five generated files. The generator needs to produce the current output under js-yaml 5 before the bump can land.

Complexity: Low
Target branch: main

Context

  • js-yaml 5.4.0 reworked scalar style selection and rewrote sortKeys.
  • DUMP_OPTS sets quotingType: '"'; under 5.5.0 strings come out single-quoted anyway.
  • The top-level on key now dumps as 'on':; unquoteOnKey only matches "on":, so the key stays quoted and the # zizmor: ignore[dangerous-triggers] suffix is dropped from automation-caller.yml.
  • The bump also adds argparse@^3.0.3 as a transitive dependency; no other package must move with it.

The Change

  • js-yaml should be upgraded to 5.5.0 or later in package.json and yarn.lock.
  • The generator should select double-quoted strings through the js-yaml 5 scalar style options (5.4.0 added scalarStyleRules).
  • unquoteOnKey should match the on key as js-yaml 5 emits it.

How to Get There

Install the dependency branch from #118 (dependabot/npm_and_yarn/js-yaml-5.5.0), then run node scripts/generate-automation.js --check.

Acceptance Criteria

  • package.json and yarn.lock pin js-yaml at 5.5.0 or later.
  • node scripts/generate-automation.js --check passes, and the prek CI job is green.
  • automation.yml, automation-caller.yml, automation-group-issues.yml, automation-group-pull-request-target.yml and automation-template.yml keep double-quoted strings and a bare on: key.
  • automation-caller.yml keeps on: # zizmor: ignore[dangerous-triggers].
  • Any remaining diff in the generated files is committed alongside the generator change.

References

AI usage

rtibblesbot (Claude Code) reviewed #118, recommended closing it, and drafted this issue from that review.

Filed from #118's review.

Activity

  1. added
    dependenciesPull requests that update a dependency file
    javascriptPull requests that update javascript code
    on Oct 25, 2026
  2. added theissue type on Oct 25, 2026
  3. rtibblesbot commented on Oct 26, 2026

    @rtibblesbot
    ContributorAuthor

    Plan: Bump js-yaml to 5.5.0 while node scripts/generate-automation.js --check still passes against the committed files.

    • Bump js-yaml to 5.5.0 and switch the dump option
    • Self-review the produced code

    Assumptions — the issue did not settle these; say so if one is wrong.

    • quoteStyle: 'double' meets "select double-quoted strings through the js-yaml 5 scalar style options"; if a custom scalarStyleRules is required, the generator gains a rule array with the same output.
    • No new unit test, because the --check prek hook guards quote style; if a maintainer wants one, add a raw-text assertion on buildReusableWorkflows output.

    Written by rtibblesbot, an LLM-based coding agent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions