https://github.com/cinderblock/github-action-debug-list-files

List (with diff) files in a working directory on action runner. Designed for debugging purposes.
https://github.com/cinderblock/github-action-debug-list-files

Last synced: 11 months ago
JSON representation

List (with diff) files in a working directory on action runner. Designed for debugging purposes.

• Host: GitHub
• URL: https://github.com/cinderblock/github-action-debug-list-files
• Owner: cinderblock
• License: mit
• Created: 2020-01-06T03:46:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T04:55:02.000Z (over 3 years ago)
• Last Synced: 2025-01-28T02:16:05.909Z (over 1 year ago)
• Language: TypeScript
• Size: 3.93 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## GitHub Action Debug Helper - List Files

List (with diff) files in a working directory on action runner. Designed for debugging purposes.

[![cinderblock/github-action-debug-list-files status](https://github.com/cinderblock/github-action-debug-list-files/workflows/Main/badge.svg?branch=master)](https://github.com/cinderblock/github-action-debug-list-files/actions?query=branch%3Amaster)

### Other Reporters

- Test Reports:

  [jest-stare](https://cinderblock.github.io/github-action-debug-list-files/jest-stare)

  [jest-html-reporters](https://cinderblock.github.io/github-action-debug-list-files/jest-html-reporters)

  [allure](https://cinderblock.github.io/github-action-debug-list-files/allure-report)

- Coverage Report:

  [lcov](https://cinderblock.github.io/github-action-debug-list-files/coverage/lcov-report)

## How It Works

Prints a list of files in the working directory and creates an artifact of the list

Subsequent calls show a diff from previous calls as well.

## Usage

In your GitHub Actions, add a config like this:

```yml

jobs:

  self-test-and-generate-stats:

    runs-on: ubuntu-latest # Anything should work

    steps:

      - name: List Working Directory Contents

        uses: cinderblock/github-action-debug-list-files@v1

        working-directory: . # Optional

        with:

          name: . # Optional different "named" lists

      # Make whatever changes you like

      - run: date >> run.log

      # Print and log a diff

      - name: List Working Directory Contents

        uses: cinderblock/github-action-debug-list-files@v1

        working-directory: . # Should probably match previous run

        with:

          name: . # Set to something different to maintain multiple lists with separate diffs

```

Multiple concurrent working directories are supported.

## Development

Setup everything

```bash

npm run all

```

Run the tests :heavy_check_mark:

```bash

npm test

 PASS  ./main.js

  ✓ throws invalid number (3ms)

  ✓ wait 500 ms (504ms)

  ✓ test runs (95ms)

...

```