Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CI workflow #167

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Update CI workflow #167

merged 2 commits into from
Jan 8, 2025

Conversation

matt-bernhardt
Copy link
Member

@matt-bernhardt matt-bernhardt commented Jan 7, 2025

This makes a few changes to our CI workflow. One is prompted by an imminent retirement, while the others are changes of convenience, given that we're touching the file at all.

The required change is to upgrade our use of actions/cache from v2 to v4. V2 will be retired in a few weeks, so we need to upgrade now or risk not being able to deploy the network. From testing on Github so far, it looks like there are no related changes to this upgrade - our current parameters and arguments continue to work.

The optional changes are:

  • Upgrading actions/checkout from v2 to v4 (also the latest available release). We have not been advised about any requirement to make this change.

  • Updating the syntax in one of our CI steps to move from set-output to a syntax using environment files. This has been showing up in our CI output for a while as a needed change, but Github has been holding off on requiring the change. More details can be found at https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

  • Adding PHP 8.4 to the list of our tested language versions. We are currently using PHP 8.1 on Pantheon, with no immediate plans to move to 8.4 for a while, but having this output now should be helpful as we plan for the future.

Ticket: https://mitlibraries.atlassian.net/browse/PW-125

Developer

Stylesheets

  • Any theme or plugin whose stylesheets have changed has had its version
    string incremented.
  • No style changes are included here

Secrets

  • All new secrets have been added to Pantheon tiers
  • Relevant secrets have been updated in Github Actions
  • All new secrets documented in README
  • No secrets are affected

Documentation

  • Project documentation has been updated
  • No documentation changes are needed

Accessibility

  • ANDI or Wave has been run in accordance to
    our guide and
    all issues introduced by these changes have been resolved or opened as new
    issues (link to those issues in the Pull Request details above)
  • There are no accessibility implications to this change

Stakeholder approval

  • Stakeholder approval has been confirmed
  • Stakeholder approval is not needed

Dependencies

NO dependencies are updated

Code Reviewer

  • The commit message is clear and follows our guidelines
    (not just this pull request message)
  • The changes have been verified
  • The documentation has been updated or is unnecessary
  • New dependencies are appropriate or there were no changes

** Why are these changes being introduced:

Github will be retiring actions/cache@v2 at the start of February 2025,
which this repository is currently configured to use.

** Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/pw-125

** How does this address that need:

This updates our CI workflow to use actions/cache@v4, which is the
latest release. No other changes appear to be needed beyond a version
bump.

** Document any side effects to this change:

None
** Why are these changes being introduced:

There are a few other regular maintenance changes that we should make to
our CI workflow:

- actions/checkout should move from v2 to v4

- Our use of a set-output command is going to be deprecated, and a new
  syntax is available (and has been adopted by the Bedrock project which
  we are following)

- PHP 8.4 has been released by that community, so we should be checking
  our network against that release

** Relevant ticket(s):

n/a for these changes, but I'm still grouping them under PW-125

** How does this address that need:

Each of the bullets above has been addressed:

- actions/checkout has been upgraded from v2 to v4

- The set-output syntax is removed in favor of the environment files,
  per https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

  Each of the above changes is made to match what the Bedrock project is
  doing.

- PHP 8.4 is added to our support matrix

  Bedrock has not yet added PHP 8.4 to their support matrix, but this
  feels like a justifiable change to make on our own.

** Document any side effects to this change:

None
@JPrevost JPrevost self-assigned this Jan 8, 2025
@matt-bernhardt matt-bernhardt merged commit 9243010 into master Jan 8, 2025
5 checks passed
@matt-bernhardt matt-bernhardt deleted the pw-125 branch January 8, 2025 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants