pantheon-systems / pantheon-systems/phpcompatibility-action

v2: Stop updating major-version branch

Open
#35 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
9
Forks
5
Avg merge
4h 34m
Merged PRs (30d)
2

Description

Summary

Stop creating/updating the floating v1 major-version branch on release. Consumers should pin by SHA with an exact version tag comment instead.

This is a breaking change for consumers currently pinned to @v1 (the branch), which is why it belongs in a major version bump. Consumers pinned by SHA are unaffected.

Work

  • Remove or disable the major-version branch update from the release workflow
  • Update documentation to recommend SHA pinning: uses: pantheon-systems/phpcompatibility-action@<sha> # v2.0.0
  • Leave existing v1 branch in place — it just stops being updated

Context

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the release workflow that creates or updates the floating v1 branch, then find the documentation showing version references. Disable only the branch update, leave the existing branch intact, and update examples to recommend SHA pinning with an exact version comment. Confirm the workflow no longer updates v1 and the documentation uses the new format.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, shell
Domain
ci-cd, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.