https://github.com/muety/readme-guestbook

A GitHub action to create a guestbook in your README from repository issues
https://github.com/muety/readme-guestbook

actions gh-actions readme

Last synced: about 1 month ago
JSON representation

A GitHub action to create a guestbook in your README from repository issues

• Host: GitHub
• URL: https://github.com/muety/readme-guestbook
• Owner: muety
• License: mit
• Created: 2020-09-12T21:01:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-05T17:22:40.000Z (8 months ago)
• Last Synced: 2024-05-05T18:34:31.052Z (8 months ago)
• Topics: actions, gh-actions, readme
• Language: JavaScript
• Homepage:
• Size: 415 KB
• Stars: 3
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# readme-guestbook

**A GitHub action that generates a simple guestbook from your repository's issues.**

## Usage

All you need to do is create a workflow file in your repository (under `.github/workflows`), see [example](examples/workflow.yml).

### Inputs

* `max_entries` (**required**): Maximum number of guestbook entries to display. Default `10`.

### Example Usage

```yaml

uses: muety/[email protected]

with:

    token: ${{ secrets.GITHUB_TOKEN }}

    max_entries: 5

```

Note: Issues need to have a title prfixed with `Guestbook` to be considered

## Development

### Setup

```bash

yarn

```

### Build

```bash

yarn build

```

### Running locally

```bash

GITHUB_REPOSITORY=muety/muety INPUT_TOKEN=ghp_notgonnatellyou INPUT_MAX_ENTRIES=10 node index.js

```

## License

MIT