https://github.com/x-color/github-actions-job-summary

It is GitHub Actions that generates GitHub Actions Job Summary with Markdown file.
https://github.com/x-color/github-actions-job-summary

actions gh-actions github-actions

Last synced: 5 months ago
JSON representation

It is GitHub Actions that generates GitHub Actions Job Summary with Markdown file.

• Host: GitHub
• URL: https://github.com/x-color/github-actions-job-summary
• Owner: x-color
• License: other
• Created: 2022-07-31T08:18:30.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T07:04:40.000Z (over 3 years ago)
• Last Synced: 2024-10-31T10:44:25.608Z (over 1 year ago)
• Topics: actions, gh-actions, github-actions
• Language: TypeScript
• Homepage:
• Size: 434 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# GitHub Actions Job Summary

It is GitHub Actions to generate GitHub Actions Job Summary with Markdown file.

## Usage

```yaml

- uses: x-color/github-actions-job-summary@v0.1.0

  with:

    file: 

    vars: |

      

```

| name | description                                  | required |

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

| file | It is a markdown file path                   | true     |

| vars | The action fills the variables into the file | false    |

## Sample

When you use these files

.github/workflows/main.yaml

```yaml

on:

  push:

      - main

jobs:

  generate:

    runs-on: ubuntu-latest

    steps:

      - name: time

        id: time

        run: |

          time=$(date)

          echo "::set-output name=time::$time"

      - uses: x-color/github-actions-job-summary@v0.1.0

        with:

          file: .github/workflows/summary.md

          vars: |

            message: sample text

            count: 3

            time: ${{ steps.time.outputs.time }}

```

.github/workflows/summary.md

```md

# Sample

'{message}' is embedded text.

Count is {count}.

Generated at {time}.

```

The action generates the following summary.

```md

# Sample

'sample text' is embedded text.

Count is 3.

Generated at Sun Jul 31 00:00:00 UTC 2022..

```