Skip to content

GitHub Actions Job Summary

Actions
It generates GitHub Actions Job Summary with Markdown file
v0.1.1
Latest
Star (3)

GitHub Actions Job Summary

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

Usage

- uses: x-color/[email protected]
  with:
    file: <file path>
    vars: |
      <variables>
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

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/[email protected]
        with:
          file: .github/workflows/summary.md
          vars: |
            message: sample text
            count: 3
            time: ${{ steps.time.outputs.time }}

.github/workflows/summary.md

# Sample

'{message}' is embedded text.
Count is {count}.
Generated at {time}.

The action generates the following summary.

# Sample

'sample text' is embedded text.
Count is 3.
Generated at Sun Jul 31 00:00:00 UTC 2022..

GitHub Actions Job Summary is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

It generates GitHub Actions Job Summary with Markdown file
v0.1.1
Latest

GitHub Actions Job Summary is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.