https://github.com/classabbyamp/treeless-checkout-action

Check out a repository with --filter=tree:0
https://github.com/classabbyamp/treeless-checkout-action

Last synced: 4 days ago
JSON representation

Check out a repository with --filter=tree:0

• Host: GitHub
• URL: https://github.com/classabbyamp/treeless-checkout-action
• Owner: classabbyamp
• License: bsd-2-clause
• Created: 2023-01-28T11:43:37.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-14T22:08:01.000Z (almost 2 years ago)
• Last Synced: 2024-12-21T05:16:05.180Z (6 days ago)
• Language: Shell
• Size: 4.88 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# treeless-checkout-action

Basic script action to check out a repository with `--filter=tree:0`.

## Inputs

| Input      | Description                        | Default                    | Required? |

|------------|------------------------------------|----------------------------|-----------|

| ref        | Ref to checkout (SHA, branch, tag) | `${{ github.ref }}`        | no        |

| repository | Repository name (foo/bar)          | `${{ github.repository }}` | no        |

| server-url | GitHub server url                  | `${{ github.server_url }}` | no        |

## Example Usage

This action is used in Void Linux's [packaging](https://github.com/void-linux/void-packages/blob/master/.github/workflows/build.yaml) and [documentation](https://github.com/void-linux/void-docs/blob/master/.github/workflows/ci.yaml) CI.

```yaml

name: Treeless Checkout Example

on:

  pull_request:

jobs:

  checkout:

    name: Checkout Repo - Treeless style

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: classabbyamp/treeless-checkout-action@v1

      - name: Show repo contents

        runs: ls -lR

```