usefulness / diffuse-action

Github Action wrapper for the Jake Wharton's Diffuse library

Diffuse - Github Action

Simple Github Action wrapper for Jake Wharton's Diffuse tool.

Usage

The action only exposes output containing the diff, so to effectively consume its output it is highly recommended to use other Github Actions to customize your experience.

Configuration:

By default, this action uses Diffuse fork - https://github.com/usefulness/diffuse (due to: JakeWharton/diffuse#111)

  - id: diffuse
    uses: usefulness/diffuse-action@v1
    with:
      old-file-path: old/file/path/old_file.apk
      new-file-path: new/file/path/new_file.apk

You can override the config to use the original Diffuse binary

  - id: diffuse
    uses: usefulness/diffuse-action@v1
    with:
      old-file-path: old/file/path/old_file.apk
      new-file-path: new/file/path/new_file.apk
      diffuse-repo: JakeWharton/diffuse
      lib-version: 0.1.0

Parameters

old-file-path - Path to reference file the diff should be generated for
new-file-path - Path to current file the diff should be generated for
lib-version (Optional) - Overrides dependency version, by default uses the latest published version
diffuse-repo (Optional) - Overrides usefulness/diffuse as the default repository containing published release artifacts.

Outputs

See full list of outputs.
For example: referencing steps.diffuse.outputs.diff-gh-comment at a later stage will print Diffuse tool output as a nicely formatted github comment

Sample: Create Pull Request comment

TODO: explain why to use free actions/cache for now and list its limitation.
Good introduction to the problem: JakeWharton/dependency-tree-diff#8 (comment)

1. Integrate with a regular Pull Request workflow:

name: Pull Request workflow

on:
  pull_request:

jobs:
  generate-diff:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v2
    
    - uses: actions/setup-java@v3
      with:
        distribution: 'temurin'
        java-version: 21
      
    - uses: gradle/actions/setup-gradle@v3
      with:
        arguments: assemble

    # Generating the diff starts here 👇 

    - uses: actions/cache@v2
      name: Download base
      with:
        path: diffuse-source-file
        key: diffuse-${{ github.event.pull_request.base.sha }}

    - id: diffuse
      uses: usefulness/diffuse-action@v1
      with:
        old-file-path: diffuse-source-file
        new-file-path: app/build/outputs/release/app.apk


    # Consuming action output starts here 👇

    - uses: peter-evans/find-comment@v1
      id: find_comment
      with:
        issue-number: ${{ github.event.pull_request.number }}
        body-includes: Diffuse output

    - uses: peter-evans/create-or-update-comment@v1
      if: ${{ steps.diffuse.outputs.diff-raw != null || steps.find_comment.outputs.comment-id != null }}
      with:
        body: |
          Diffuse output (customize your message here): 

          ${{ steps.diffuse.outputs.diff-gh-comment }}
        edit-mode: replace
        comment-id: ${{ steps.find_comment.outputs.comment-id }}
        issue-number: ${{ github.event.pull_request.number }}
        token: ${{ secrets.GITHUB_TOKEN }}

    - uses: actions/upload-artifact@v2
      with:
        name: diffuse-output
        path: ${{ steps.diffuse.outputs.diff-file }}

2. Integrate with you post-merge flow:

on:
  push:
    branches:
      - master
      - main
      - trunk
      - develop
      - maine
      - mane
  schedule:
    - cron: '0 3 * * 1,4'

jobs:
  diffuse_cache:
    runs-on: ubuntu-latest
    name: Cache artifact for diffuse
    steps:
      - uses: actions/checkout@v2
      
      - uses: actions/setup-java@v3
        with:
          distribution: 'temurin'
          java-version: 21
          
      - uses: gradle/actions/setup-gradle@v3
        with:
          arguments: assemble

      # Integration starts here 👇 
      
      - uses: actions/cache@v2
        name: Upload base
        with:
          path: diffuse-source-file
          key: diffuse-${{ github.sha }}

      # Copy your build artifact under `diffuse-source-file` name which will be saved in cache
      - run: cp /app/build/outputs/debug/sample-apk.apk diffuse-source-file 
        shell: bash

More examples

Sample application as a pull request comment
Corresponding workflow file

🙏 Praise 🙏 be 🙏 to 🙏 Wharton 🙏

diffuse-action's Issues

TypeError exception

I tried to use this action for comparison two CSVs, unfortunately it fails. I tried both with the default diffuse-repo and with JakeWharton's one.
Please suggest.
TIA,
Vitaly

- id: diffuse
        uses: usefulness/diffuse-action@v1
        with:
          old-file-path: file1.csv
          new-file-path: file2.csv
          diffuse-repo: JakeWharton/diffuse
          lib-version: 0.1.0

Traceback (most recent call last):
  File "/home/runner/work/_actions/usefulness/diffuse-action/v1/entrypoint.py", line 139, in <module>
    print(" ".join(java_call))
TypeError: sequence item 4: expected str instance, NoneType found

Error during python3 install request on ubuntu-24.04 runners

I using the latest 0.10.1 version on the new ubuntu-24.04 runner.

python3 -m pip install requests
  # shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
  # env:
  #  JAVA_HOME: /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.11-9/x64
  # JAVA_HOME_17_X64: /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/17.0.11-9/x64

I receive the following error when the command above is executed:

error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.
    
    If you wish to install a non-Debian-packaged Python package,
    create a virtual environment using python3 -m venv path/to/venv.
    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
    sure you have python3-full installed.
    
    If you wish to install a non-Debian packaged Python application,
    it may be easiest to use pipx install xyz, which will manage a
    virtual environment for you. Make sure you have pipx installed.
    
    See /usr/share/doc/python3.12/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .github/renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error: expecting end of expression or separator near ] "exte

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/after_merge.yml

• actions/checkout v4
• actions/setup-java v4
• actions/upload-artifact v4

.github/workflows/main.yml

• actions/checkout v4
• actions/setup-java v4
• actions/download-artifact v4
• actions/download-artifact v4
• peter-evans/find-comment v3
• peter-evans/create-or-update-comment v4
• actions/upload-artifact v4
• actions/checkout v4
• actions/setup-java v4
• actions/download-artifact v4
• actions/download-artifact v4
• peter-evans/find-comment v3
• peter-evans/create-or-update-comment v4
• actions/upload-artifact v4
• actions/upload-artifact v4
• actions/upload-artifact v4
• actions/upload-artifact v4
• actions/checkout v4
• actions/setup-java v4
• actions/download-artifact v4
• actions/download-artifact v4
• actions/upload-artifact v4
• actions/upload-artifact v4

---

• Check this box to trigger a request for Renovate to run again on this repository