Astro Automation Tools

https://github.com/withastro/automation
Admin
A collection of shared GitHub Action workflows for the withastro GitHub organization, including a...
Tokens:3,906
Snippets:21
Trust Score:8.5
License:MIT
Update:11 months ago
Show doc for...
Tokens:
Raw
### GitHub Actions: Reusable PNPM Package Script Runner Workflow

Source: https://context7.com/withastro/automation/llms.txt

This reusable workflow provides a standardized method for executing any pnpm package.json script within a CI environment. It handles Node.js setup, dependency installation using pnpm, and command execution. This workflow is versatile for tasks like running tests, builds, or other package scripts, and supports custom Node.js versions.

```yaml
# .github/workflows/test.yml
name: Test

on:
  pull_request:
  push:
    branches: [main]

jobs:
  test:
    uses: withastro/automation/.github/workflows/pnpm.yml@main
    with:
      command: 'test'

# With custom Node version
jobs:
  build:
    uses: withastro/automation/.github/workflows/pnpm.yml@main
    with:
      command: 'build'
      node-version: '20'

# Multiple jobs for different commands
jobs:
  test:
    uses: withastro/automation/.github/workflows/pnpm.yml@main
    with:
      command: 'test'

  lint:
    uses: withastro/automation/.github/workflows/pnpm.yml@main
    with:
      command: 'lint'

  typecheck:
    uses: withastro/automation/.github/workflows/pnpm.yml@main
    with:
      command: 'typecheck'
      node-version: '20'

```

--------------------------------

### Automatic Code Formatting and Committing

Source: https://context7.com/withastro/automation/llms.txt

This workflow automates code formatting using tools like Prettier and automatically commits any changes made. It utilizes pnpm to run the specified formatting command and applies a standardized commit message. It can be triggered on pushes to the main branch or manually. Requires a 'format:ci' script in package.json.

```yaml
# .github/workflows/format.yml
name: Format

on:
  workflow_dispatch:
  push:
    branches:
      - main

jobs:
  prettier:
    if: github.repository_owner == 'withastro'
    uses: withastro/automation/.github/workflows/format.yml@main
    with:
      command: 'format:ci'
    secrets: inherit
```

```yaml
# Example with custom command
jobs:
  format:
    if: github.repository_owner == 'withastro'
    uses: withastro/automation/.github/workflows/format.yml@main
    with:
      command: 'lint:fix'
    secrets: inherit
```

```json
# Requires package.json script:
# {
#   "scripts": {
#     "format:ci": "prettier --write ."
#   }
# }

# Results in automatic commit:
# Commit message: "[ci] format"
# Author: astrobot-houston
```

--------------------------------

### JavaScript: GitHub Actions Output Utility (utils.mjs)

Source: https://context7.com/withastro/automation/llms.txt

The utils.mjs module provides a `setOutput` function for writing output variables in GitHub Actions workflows. It adheres to GitHub's recommended file command approach, using unique delimiters for safe handling of multiline values. This utility is essential for passing formatted data, such as Discord messages, between workflow steps. It handles various data types and ensures secure delimiter usage.

```javascript
// Example usage in GitHub Actions Node.js script
import { setOutput } from './utils.mjs';

// Set a simple string output
setOutput('DISCORD_MESSAGE', 'Hello from GitHub Actions!');

// Set multiline output safely
const multilineMessage = `Line 1
Line 2
Line 3`;
setOutput('MESSAGE', multilineMessage);

// Set JSON output
const data = { status: 'success', count: 42 };
setOutput('RESULT', data);

// In workflow, access the output:
// steps:
//   - id: message
//     run: node script.mjs
//   - name: Use output
//     run: echo "${{ steps.message.outputs.DISCORD_MESSAGE }}"

// The function writes to GITHUB_OUTPUT file with format:
// KEY<<gh-delimiter-uuid
// value content here
// gh-delimiter-uuid

// Handles edge cases:
// - null/undefined → empty string
// - objects → JSON.stringify
// - validates delimiter not in key/value for security

```

--------------------------------

### format.yml: Automatically format code and commit changes

Source: https://github.com/withastro/automation/blob/main/README.md

This GitHub Action workflow runs code formatting tools, such as Prettier, on a repository's code and automatically commits any resulting changes. It is triggered on workflow dispatch or push events to the main branch. The command to run the formatter is provided as an input.

```yaml
name: Format

on:
  workflow_dispatch:
  push:
    branches:
      - main

jobs:
  prettier:
    if: github.repository_owner == 'withastro'
    uses: withastro/automation/.github/workflows/format.yml@main
    with:
      # Set command to this repository’s package script that runs Prettier
      command: 'format:ci'
    secrets: inherit
```

--------------------------------

### GitHub Actions: Automatic Issue Triage Labeling Workflow

Source: https://context7.com/withastro/automation/llms.txt

This workflow automatically adds a 'needs triage' label to newly opened issues in repositories under the 'withastro' organization. It leverages GitHub's REST API via github-script and requires no additional configuration. It's designed to ensure all new issues are identified for the triage process.

```yaml
# .github/workflows/issue-opened.yml
name: Label Issues

on:
  issues:
    types: [opened]

jobs:
  label_issues:
    uses: withastro/automation/.github/workflows/issue-opened.yml@main

# Automatically applies "needs triage" label to new issues
# No configuration required
# Works only for repositories under the 'withastro' organization

```

--------------------------------

### JavaScript: Discord Message Formatter Module (congratsbot.mjs)

Source: https://context7.com/withastro/automation/llms.txt

The congratsbot.mjs module processes commit metadata to generate formatted Discord messages. It extracts co-author details, includes random emojis, and supports customizable co-author templates. This module formats outputs into Discord-compatible markdown, useful for commit notifications. Environment variables like COMMIT_AUTHOR, COMMIT_ID, and COMMIT_MESSAGE are required for its operation.

```javascript
// Example usage in GitHub Actions context
// Environment variables required:
// - COMMIT_AUTHOR: "John Doe"
// - COMMIT_ID: "abc123def456"
// - COMMIT_MESSAGE: "fix: resolve bug\n\nCo-authored-by: Jane Smith <jane@example.com>"
// - GITHUB_REPO: "withastro/starlight"
// - EMOJIS: "🎉,🎊,🚀" (optional)
// - COAUTHOR_TEMPLATES: JSON array of templates (optional)

// The module processes commits like:
const commitMessage = `fix: resolve navigation bug\n\nAdded null check for menu items\n\nCo-authored-by: Jane Smith <jane@example.com>\nCo-authored-by: Bob Johnson <bob@example.com>`;

// Output format:
// 🎉 **Merged!** John Doe: [`fix: resolve navigation bug`](https://github.com/withastro/starlight/commit/abc123)
// _Made even better by Jane Smith & Bob Johnson! 🚀_

// Custom emoji configuration
process.env.EMOJIS = '🤖,👻,😱';
process.env.COAUTHOR_TEMPLATES = JSON.stringify([
  'Thanks <names> for the assist! 💪',
  '<names> made this PR amazing! ✨'
]);

// Single co-author output:
// 🤖 **Merged!** John Doe: [`fix: resolve navigation bug`](https://github.com/withastro/starlight/commit/abc123)
// _Thanks Jane Smith for the assist! 💪_

// Multiple co-authors are formatted as: "Jane Smith, Bob Johnson & Alice Williams"

```

--------------------------------

### congratsbot.yml: Post celebratory messages on commits

Source: https://github.com/withastro/automation/blob/main/README.md

This GitHub Action workflow posts a celebratory message to a Discord channel for each commit. It requires a Discord webhook URL to be configured as a repository secret. Optional inputs allow customization of emojis and co-author message templates.

```yaml
name: Congratsbot

on:
  push:
    branches: [main]

jobs:
  congrats:
    if: ${{ github.repository_owner == 'withastro' }}
    uses: withastro/automation/.github/workflows/congratsbot.yml@main
    secrets:
      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_CONGRATS }}
```

```yaml
jobs:
  congrats:
    if: ${{ github.repository_owner == 'withastro' }}
    uses: withastro/automation/.github/workflows/congratsbot.yml@main
    with:
      EMOJIS: 🤖,👻,😱
      COAUTHOR_TEMPLATES: >
        [
          "Woahhh, <names> really gave us a fright! 🎃",
          "We weren’t sure what we were doing until <names> showed up. 🤝"
        ]
    secrets:
      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_CONGRATS }}
```

--------------------------------

### Automated Issue Responses Based on Labels

Source: https://context7.com/withastro/automation/llms.txt

This workflow automatically responds to issues based on added labels. It can remove the 'needs triage' label when priority labels are applied and posts a predefined message when the 'needs repro' label is added. This streamlines issue management by providing consistent automated feedback.

```yaml
# .github/workflows/issue-labeled.yml
name: Issue Labeled

on:
  issues:
    types: [labeled]

jobs:
  reply-labeled:
    uses: withastro/automation/.github/workflows/issue-labeled.yml@main
```

```yaml
# With custom reproduction request message
jobs:
  reply-labeled:
    uses: withastro/automation/.github/workflows/issue-labeled.yml@main
    with:
      repro_message_content: |
        Hello @${{ github.event.issue.user.login }}!

        We need a minimal reproduction to investigate this issue. Please provide:
        - A GitHub repository with minimal code to reproduce the issue
        - Or a StackBlitz project at https://astro.new

        Issues without reproductions will be closed after 3 days of inactivity.
```

```text
# Behavior:
# 1. When priority label added → removes "needs triage" label
# 2. When "needs repro" label added → posts message and removes "needs triage"
```

--------------------------------

### Discord Notification for Merged Commits (Congratsbot)

Source: https://context7.com/withastro/automation/llms.txt

This workflow sends celebratory Discord messages for merged commits to the main branch. It parses commit details, recognizes co-authors, and uses a JavaScript module to format and send messages to a Discord webhook. It can be customized with emojis and co-author message templates.

```yaml
# .github/workflows/main.yml
name: Congratsbot

on:
  push:
    branches: [main]

jobs:
  congrats:
    if: ${{ github.repository_owner == 'withastro' }}
    uses: withastro/automation/.github/workflows/congratsbot.yml@main
    secrets: 
      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_CONGRATS }}
```

```yaml
# With custom configuration
jobs:
  congrats:
    if: ${{ github.repository_owner == 'withastro' }}
    uses: withastro/automation/.github/workflows/congratsbot.yml@main
    with:
      EMOJIS: 🤖,👻,😱,🎃
      COAUTHOR_TEMPLATES: >
        [
          "Woahhh, <names> really gave us a fright! 🎃",
          "We weren't sure what we were doing until <names> showed up. 🤝",
          "Thanks to <names> for the spooky contributions! 👻"
        ]
    secrets: 
      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_CONGRATS }}
```
Tokens:
Raw