github-action-composer.lock-diff

GitHub Action that diffs composer.lock between current branch and default branch

Options (inputs)

This action supports the following option.

dryRun

Whether to run this action in dry-run mode or not. Setting this to yes will prevent this action from commenting.

• Required: No
• Type: string
• Example: yes

workingDirectory

Which directory to run the composer diffing in.

• Required: No
• Type: string
• Example: path/to/directory/

Output

This action has two outputs: the production and development outputs respective tables for each set of dependencies.

Example

The following example comments on any PR, this example uses the pull_request_target trigger which gives it additional permissions. Be sure to read the documentation and this blog post on security for using this special trigger.

name: Composer Diff
on:
  ## To make this workflow work in the simplest way possible, without a PAT or juggling information between, we need to
  ## run it with permissions as if it was already merged.
  ## Refs: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target
  ## Refs: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
  ## Refs: https://twitter.com/WyriHaximus/status/1393679576828686340
  pull_request_target:
    types:
      - opened
      - synchronize
      - reopened
## This workflow needs the `pull-request` permissions to work
## Refs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions
permissions:
  pull-requests: write
  contents: read
jobs:
  comment-composer-lock-diff:
    name: Comment composer.lock diff
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0
      - name: Comment composer.lock diff
        uses: WyriHaximus/github-action-composer.lock-diff@v2
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Reasoning

The author of the package used in this action also has an Action for it. Decided to build a different action so you always get the development and production dependencies changes in their own outputs and comments instead of just the output with everything depending on flags and no commenting (+ updates on pushes). That became v1 of this action, v2 introduces looking at the merged commit sha coming from the GitHub API. This sha is the sha of when the PR would be merged, meaning this action compares between what is currently there, the base branch, and what would be there is the PR this action runs on is merged. This is done because the head branch that contains the changeset for the PR might be behind on changes in the base branch, and thus the comparison would be wrong.

License

Copyright 2024 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.