Skip to content
info

GitHub Action

Get Description From README Action

v1.0.2 Latest version

Get Description From README Action

info

Get Description From README Action

GitHub Action to get description from README

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Get Description From README Action

uses: rtvu/[email protected]

Learn more about this action in rtvu/get-description-from-readme-action

Choose a version

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.