https://github.com/fabasoad/setup-groff-action

This GitHub action installs groff (GNU roff)
https://github.com/fabasoad/setup-groff-action

github-action github-actions programming-language roff roff-lang roff-language

Last synced: about 2 months ago
JSON representation

This GitHub action installs groff (GNU roff)

• Host: GitHub
• URL: https://github.com/fabasoad/setup-groff-action
• Owner: fabasoad
• License: mit
• Created: 2024-06-11T12:56:59.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-03-23T22:03:08.000Z (about 2 months ago)
• Last Synced: 2025-03-28T05:28:51.661Z (about 2 months ago)
• Topics: github-action, github-actions, programming-language, roff, roff-lang, roff-language
• Language: Shell
• Homepage:
• Size: 20.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Setup groff (GNU roff)

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

![GitHub release](https://img.shields.io/github/v/release/fabasoad/setup-groff-action?include_prereleases)

![functional-tests](https://github.com/fabasoad/setup-groff-action/actions/workflows/functional-tests.yml/badge.svg)

![security](https://github.com/fabasoad/setup-groff-action/actions/workflows/security.yml/badge.svg)

![linting](https://github.com/fabasoad/setup-groff-action/actions/workflows/linting.yml/badge.svg)

This action sets up [groff (GNU roff)](https://www.gnu.org/software/groff).

## Prerequisites

| OS      | Supported          | Tools  |

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

| Linux   | :white_check_mark: | None   |

| macOS   | :white_check_mark: | `brew` |

| Windows | :x:                | N/A    |

## Inputs

```yaml

- uses: fabasoad/setup-groff-action@v0

  with:

    # (Optional) If "true" it installs groff even if it is already installed on

    # a runner. Otherwise, skips installation. Defaults to "false".

    force: "false"

```

## Outputs

| Name      | Description                        | Example |

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

| installed | Whether groff was installed or not | `true`  |

## Example

Let's try to run [hello-world.roff](./hello-world.roff) file using the workflow

below.

```yaml

name: Setup groff

on: push

jobs:

  setup:

    name: Setup

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: fabasoad/setup-groff-action@v0

      - run: groff -man -Tascii hello.roff

```

And you should see the following output:

```text

HELLO(1)                    General Commands Manual                   HELLO(1)

NAME

       hello - print Hello, World!

SYNOPSIS

       hello

DESCRIPTION

       The hello command prints "Hello, World!" to the standard output.

EXAMPLES

       hello

       Hello, World!

Hello Manual                       June 2024                          HELLO(1)

```