Skip to content

ci: Vendor Update bumps a beta on a regeneration that changes only comments #1674

Closed

Description

@JarryShaw

Problem. cron-vendor.yml bumps the version and pushes whenever tj-actions/verify-changed-files@v17 reports any changed file, after pcapkit-vendor and isort. A regeneration that changes only comments or docstrings therefore cuts a beta and starts a Create Release run. That happened twice today: b10 and b11 changed only reference formatting (#1664, fixed by #1673).

Measured (prototype in #1673's notes): comparing each changed pcapkit/const/**/*.py with HEAD by AST, docstrings stripped, classifies b9, b10 and b11 as comment-only and still flags b8's member rename. But b9 was a genuine upstream change, a draft becoming RFC 10049, that lives only in comments.

Decision needed — when a regeneration is comment-only:

  1. commit it without bumping the version, so the next real change carries it into a release;
  2. drop it, and commit nothing;
  3. keep today's behaviour, and bump on any change.

Recommended: (1). Documentation-only upstream updates such as b9's still reach main, and only a code change cuts a beta.

Activity

  1. added
    ciPull requests that change CI or workflow configuration (ci: subject prefix)
    needs: decisionWaiting on the maintainer to decide — not blocked by other work
    on Oct 13, 2026
  2. JarryShaw commented on Oct 13, 2026

    @JarryShaw
    OwnerAuthor

    Take (1) but if it's too complex to implement, I'd keep today's behaviour - comments are generated as docs so they can be useful for new releases.

  3. JarryShaw commented on Oct 13, 2026

    @JarryShaw
    OwnerAuthor

    Recorded: option (1). A regeneration whose only changes are comments or docstrings gets committed without a version bump, so it reaches main without cutting a beta. A worker has it. The plan is a stdlib AST guard in cron-vendor.yml, which compares each changed pcapkit/const module with HEAD with docstrings stripped, and bumps only when some module's code differs.

    If the guard turns out too complex or fragile in practice, I'll come back here before falling back to today's behaviour.

  4. added
    wipWork in flight - a covering PR is open or an agent is actively on it
    and removed
    needs: decisionWaiting on the maintainer to decide — not blocked by other work
    on Oct 13, 2026
  5. moved this from Needs decision to WIP in PyPCAPKiton Oct 13, 2026
  6. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ciPull requests that change CI or workflow configuration (ci: subject prefix)

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions