Skip to content

Get Description From README Action

Actions
GitHub Action to get description from README
v1.0.2
Latest
By rtvu
Star (0)

Tags

 (1)

GET-DESCRIPTION-FROM-README-ACTION

GitHub Action to get description from README.

README Format

The first paragraph of the first header is considered the description.

Usage

steps:
  -
    name: 'Checkout repository'
    uses: actions/checkout@v4
  -
    name: 'Get README description'
    id: get-description
    uses: rtvu/get-description-from-readme-action@v1
  -
    name: 'Echo description'
    run: echo ${{ steps.get-description.outputs.description }}

Inputs

Name Description Default
readme Path to repository's README. README.md

Outputs

Name Description
description README's description.

Get Description From README Action 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

GitHub Action to get description from README
v1.0.2
Latest
By rtvu

Tags

 (1)

Get Description From README Action 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.