ChecKMarK Upkeep Docs Action

🦄 I’ve been threatening to build this for months, and here it finally is — ChecKMarK Upkeep Docs Action. Built to play nice with GitHub, using your own rules, tokens, and permissions. I’m just the orchestrator in the situation: you pull the trigger, I hand it straight to the Coding Agent with my documentation prompts. From there, the plan is simple—magic. 🪄

ChecKMarK Upkeep Docs Action is a GitHub Action that leverages the GitHub Copilot CLI to send Coding Agent on a mission to create the perfect systems documentation automatically. It’s the first step toward full doc orchestration—an intelligent prompter for GitHub’s coding agent that analyzes your codebase and builds documentation through pull requests.

I plan to expand into other areas (test cases are probably next), but this one already works well enough to stand on its own.

Your data is yours. I don’t log or store anything, ever. At some point, I may enable anonymous statistics, but all activity is visible directly inside your workflow runs—no hidden analytics, no surprises. This repo is scanned regularly for vulnerabilities, and every prompt sent to Coding Agent is hand-written by me and scrubbed again by GitHub before it ever looks at your repo.

Once Coding Agent takes over, my job is done here—that means it's up to you to iterate on results with the @copilot mention and report back any strangeness—I'll get it on the list.

✨ Features

• 🤖 AI-Powered: Uses GitHub Copilot CLI for intelligent documentation generation
• 📝 Zero Configuration: Works out of the box with the default GitHub token (at least, that's the plan!)
• 🔄 Pull Request Integration: Creates reviewable pull requests with generated docs
• 🔒 Security First: Comprehensive security scanning and best practices

🚀 Quick Start

name: Generate Documentation
on:
  workflow_dispatch:
  pull_request:
    types: [opened, edited, reopened, synchronize]

jobs:
  upkeep-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/upkeep-docs@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

📖 Usage

Basic Usage

- uses: actions/upkeep-docs@v1
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}

🔧 Inputs

Input	Description	Required	Default
github-token	GitHub token for API access	✅	${{ github.token }}

Required Token Permissions

The action requires the following permissions for the GITHUB_TOKEN:

• contents: write - Create and modify documentation files
• pull-requests: write - Create pull requests with generated documentation
• metadata: read - Read repository metadata (default)

Minimal Permission Configuration

permissions:
  contents: write
  pull-requests: write
  metadata: read

Using Default GITHUB_TOKEN

The default GITHUB_TOKEN typically has sufficient permissions, but you may need to explicitly grant write permissions in your workflow:

jobs:
  upkeep-docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/upkeep-docs@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

🏗️ Development

Prerequisites

• Node.js 22 (managed with Volta)
• npm
• GitHub Copilot

Setup

# Clone the repository
git clone https://github.com/ChecKMarKDevTools/checkmark-upkeep-docs-action
cd checkmark-upkeep-docs-action

# Install dependencies
npm install

# Run tests
npm test

Project Structure

├── .github/workflows/    # CI/CD workflows
├── .kiro/               # AI assistant configuration
├── src/                 # Source code
│   ├── main.js         # Action entry point
│   ├── copilot-cli.js  # Copilot CLI integration
│   └── utils.js        # Utilities
├── tests/              # Test suites
├── docs/               # Astro documentation site
└── action.yml          # Action metadata

🧪 Testing

# Unit tests
npm test

# Integration tests
npm run test:integration

# Prettier formatting
npm run format

# ESLint
npm run lint

📚 Documentation

Documentation site is coming soon for comprehensive guides, examples, and more. Stay tuned!

🔒 Security

Security is a top priority. Please see our Security Policy for reporting vulnerabilities.

📄 License

Licensed under my personal Polyform Shield 1.0.0 - allows free use with appropriate restrictions. That means this project isn’t here for resale or repackaging. You can build with it, learn from it, fork it, remix it — just don’t slap a logo on top and call it your startup. I built this for the community, not for recycling relabeled as entrenupership. 💅

---

🌐 Connect

📖 Documentation 🐛 Issues

Kiro says he made this with ❤️ — like I wasn't helping 🙄