https://github.com/reitzig/actions-asciidoctor

GitHub Action that installs asciidoctor
https://github.com/reitzig/actions-asciidoctor

asciidoc asciidoctor github-actions

Last synced: 3 months ago
JSON representation

GitHub Action that installs asciidoctor

• Host: GitHub
• URL: https://github.com/reitzig/actions-asciidoctor
• Owner: reitzig
• License: mit
• Created: 2020-05-28T14:45:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T07:10:47.000Z (about 1 year ago)
• Last Synced: 2025-06-30T14:48:50.617Z (3 months ago)
• Topics: asciidoc, asciidoctor, github-actions
• Language: JavaScript
• Homepage:
• Size: 147 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![license](https://img.shields.io/github/license/reitzig/actions-asciidoctor.svg)](https://github.com/reitzig/actions-asciidoctor/blob/master/LICENSE)

[![release](https://img.shields.io/github/release/reitzig/actions-asciidoctor.svg)](https://github.com/reitzig/actions-asciidoctor/releases/latest)

[![GitHub release date](https://img.shields.io/github/release-date/reitzig/actions-asciidoctor.svg)](https://github.com/reitzig/actions-asciidoctor/releases)

![Test](https://github.com/reitzig/actions-asciidoctor/workflows/Test/badge.svg?branch=master&event=push)

# Asciidoctor Setup Action

This Action can install

    [Asciidoctor](https://asciidoctor.org/)

to a virtual machine of GitHub Actions. 

## Usage

Given that Ruby has already been installed 

(e.g. by [ruby/setup-ruby](https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby)), 

include this in your workflow:

```yml

 - uses: reitzig/actions-asciidoctor@v2.0.2

```

These inputs are allowed:

 - `version` -- a [Gemfile-compatible version string](https://guides.rubygems.org/patterns/#declaring-dependencies)  

   _Default:_ empty; installs the latest version.

### Working Example

```yml

name: Asciidoctor Demo

on:

  push:

    branches:

      - master

jobs:

  example:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: ruby/setup-ruby@v1

        with:

          ruby-version: 2.7

      - uses: reitzig/actions-asciidoctor@v2.0.2

        with:

          version: 2.0.18

      - run: asciidoctor --version

```

## Acknowledgements

 - [@peaceiris](https://github.com/peaceiris) lent inspiration, 

   [example](https://github.com/peaceiris/actions-hugo), and 

   [pointers](https://github.com/reitzig/today-i-learned/pull/1/).

 - A bunch of Stackoverflow answers helped cobble this together.

 - Parts of this project were created during 

     [20% time](https://en.wikipedia.org/wiki/20%25_Project) 

   graciously provided by 

     [codecentric](https://codecentric.de).

   Thank you!