https://github.com/ryohidaka/action-get-description

GitHub Actions to get repository description.
https://github.com/ryohidaka/action-get-description

description github-actions

Last synced: about 2 months ago
JSON representation

GitHub Actions to get repository description.

• Host: GitHub
• URL: https://github.com/ryohidaka/action-get-description
• Owner: ryohidaka
• Created: 2025-04-28T12:26:33.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-12T04:26:02.000Z (about 1 year ago)
• Last Synced: 2025-05-12T05:29:16.352Z (about 1 year ago)
• Topics: description, github-actions
• Language: Shell
• Homepage: https://github.com/marketplace/actions/get-description
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# Get Description

[![GitHub Release](https://img.shields.io/github/v/release/ryohidaka/action-get-description)](https://github.com/ryohidaka/action-get-description/releases/)

[![Test Action](https://github.com/ryohidaka/action-get-description/actions/workflows/test.yml/badge.svg)](https://github.com/ryohidaka/action-get-description/actions/workflows/test.yml)

GitHub Actions to get repository description.

## Usage

```yml

on: [push]

jobs:

  get-description:

    runs-on: ubuntu-latest

    steps:

      - name: Run Get Description Action

        id: get_description

        uses: ryohidaka/action-get-description@v0.1.1

        with:

          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Show Description

        run: |

          echo "${{ steps.get_description.outputs.description }}"

```

## Inputs

| Input        | Description                               | Required | Default            |

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

| `token`      | GitHub Token for API access               | ✅       |                    |

| `repository` | The repository in the format `owner/repo` |          | current repository |

## Outputs

| Output        | Description                       | Example                                         |

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

| `description` | The description of the repository | `GitHub Actions to get repository description.` |