Random Proverb

GitHub Action to provide random proverbs on issues/pull requests

Table of contents

• Description
• Inputs
  • sourceData
  • requestId
  • theme
  • layout
  • GITHUB_TOKEN
• Examples
  • Basic configuration
  • Complete configuration
• Visitor stats
• Licensing
• Authors
• Versioning
• Contribution
• Acknowledgement
• Forks
• Development Support

Description

Provides random proverbs on GitHub issues/pull requests.

Inputs

sourceData

Optional JSON data source file with action parameters:

[
    {
        "styleOptions": {
            "theme": "nightOwl",
            "layout": "churchill"
        },
        "resourceOptions": {
            "requestId": 10
        }
    },
    {
        "resourceOptions": {
            "requestId": 9
        }
    }
]

requestId

Optional Request identifier

theme

Optional Proverb image theme

layout

Optional Proverb image layout

GITHUB_TOKEN

Required GitHub action token

Examples

Basic configuration

- name: Random proverb on issue by current pull request
  uses: alexrogalskiy/github-action-random-proverb@master
  with:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Complete configuration

- name: Random proverb on issue by current pull request
  uses: alexrogalskiy/github-action-random-proverb@master
  with:
    theme: 'nightOwl'
    layout: 'churchill'
    requestId: 10
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Running locally:

• npm run start:action --action github-action-random-proverb --GITHUB_TOKEN ${{ secrets.GITHUB_TOKEN }}

Visitor stats

Licensing

File Size is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.

Authors

File Size is maintained by the following GitHub team-members:

with community support please contact with us if you have some question or proposition.

Versioning

The project uses SemVer for versioning. For the versions available, see the tags on this repository.

Contribution

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us (emoji key).

This project follows the all-contributors specification. Contributions of any kind are welcome!

See also the list of contributors who participated in this project.

Acknowledgement

Forks

Development Support

Like File Size ? Consider buying me a coffee :)