// GITHUB ACTION · MARKETPLACE · v1

GUESTBOOK.

Turn GitHub Issues into a community guestbook. One action, zero config, entries land straight in your README.

COMPOSITE ACTION MIT LICENSE ZERO DEPENDENCIES

VIEW ON GITHUB → GET STARTED

01 · HOW IT WORKS

THREE STEPS

// OPEN ISSUE

VISITOR SIGNS

Anyone opens an issue with your configured label. The issue title becomes their greeting, the body their message.

// ACTION RUNS

ENTRY WRITTEN

The action sanitizes input, appends a formatted blockquote between your README markers, and updates the entry count.

// AUTO CLOSE

ISSUE RESOLVED

A thank-you comment is posted and the issue closes automatically. The guestbook entry lives on in your README.

02 · USAGE

DROP-IN WORKFLOW

.github/workflows/guestbook.yml

name: Guestbook
on:
  issues:
    types: [opened]

permissions:
  contents: write
  issues: write

jobs:
  sign:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Sign guestbook
        uses: zackkitzmiller/gha-guestbook@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

Add the markers  and  to your README, plus a count header ## 📖 GuestBook — 0 Entries.

03 · FEATURES

WHAT YOU GET

// LABEL GATE

FILTERED ENTRIES

Only issues with your configured label trigger a guestbook write. Default: guestbook. Change it to anything.

// AUTO CLOSE

CLEAN ISSUES TAB

Posts a thank-you comment and closes the issue automatically. Toggle off with close_issue: 'false'.

// LIVE COUNT

ENTRY COUNTER

The guestbook header updates automatically — always reflects the real number of entries between your markers.

// FLEXIBLE

CUSTOM PATHS

Point at any markdown file with readme_path. Put your guestbook in GUESTBOOK.md or anywhere else.