https://github.com/robintail/bun-diff-action

A composite action that writes the diff of bun.lockb file into a comment of pull request
https://github.com/robintail/bun-diff-action

Last synced: over 1 year ago
JSON representation

A composite action that writes the diff of bun.lockb file into a comment of pull request

• Host: GitHub
• URL: https://github.com/robintail/bun-diff-action
• Owner: RobinTail
• License: mit
• Created: 2024-09-07T08:04:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-09T16:23:21.000Z (over 1 year ago)
• Last Synced: 2025-03-25T18:46:51.839Z (over 1 year ago)
• Homepage:
• Size: 95.7 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# RobinTail/bun-diff-action

A composite action that writes the diff of `bun.lockb` file into a comment of pull request.

The `diff` syntax is highlighted and the action keeps that comment up to date.

⚠️ Bun has switched to a text-based lockfile so that this action is no longer required:

[read more about it and find out how to upgrade](https://bun.sh/blog/bun-lock-text-lockfile).

![Demo comment](demo.jpg)

## Requirements

- Running on `pull_request` event,

- Permission to `write` comments to the pull request,

- Check out with `fetch-depth: 0`,

- Install `bun`.

## Usage

```yaml

on: pull_request

permissions:

  pull-requests: write # for comments in PRs

jobs:

  sample:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

        with: # required!

          fetch-depth: 0

      - name: Install bun

        uses: oven-sh/setup-bun@v2

        with:

          bun-version: latest

      - name: Show the bun lock diff

        # in case the workflow has multiple triggers:

        # if: github.event_name == 'pull_request'

        uses: RobinTail/bun-diff-action@v... # set the version

```

### Options

```yaml

with:

  working-directory:

    description: Directory to find bun.lockb file

    required: false

    default: .

```

## Alternatives

- https://github.com/koki-develop/bun-diff-action

  - Written in Typescript,

  - Runs on Node 20,

  - Can install `bun` itself.