Skip to content

Compare the differences between two commits

License

Notifications You must be signed in to change notification settings

cpcloud/compare-commits-action

Repository files navigation

Compare the Differences Between Two Commits

This action will compare the differences in a commit range and generate a Markdown table that looks like this:

SHA256 Commit Message Pull Requests
59be1f49 dunst: add option to read alternative configuration file (#2113)

Usage in a GitHub workflow

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Compare commits
        uses: cpcloud/compare-commits-action@v2.0.4
        with:
          owner: nix-community
          repo: home-manager
          basehead: A...B
          token: ${{ secrets.GITHUB_TOKEN }}
          verbose: true # this will print the markdown table to the console

Inputs

inputs:
  owner:
    required: true
    description: "The owner of the GitHub repository"
  repo:
    required: true
    description: "The GitHub repository name"
  basehead:
    required: true
    description: "The commit range to compare"
  token:
    required: false
    description: "Access token to increase the rate limit for GitHub API requests"
  include-merge-commits:
    required: false
    description: "Whether to show merge commits in the log"
    default: "false"
  sha-length:
    required: false
    description: "The short length of the SHA256 displayed in the output table"
    default: "8"
  verbose:
    required: false
    description: "Print the generated Markdown table to the console"
    default: "false"

Outputs

outputs:
  differences:
    description: "A markdown formatted table of differences between two commits"