ast-gh-actions

A library or collection of AST github shared composite actions.

Development

Git Pre-commit Hook

The repository uses a pre-commit hook to run linting on all TypeScript projects.

This runs automatically when installing dependencies in the root directory of the actions.

When adding a new action, update .githooks/pre-commit to include your project:

Pre-commit Hook

The pre-commit hook:

• Builds TypeScript files
• Stages compiled dist files
• Runs linting

GitHub Workflows

Lint

.github/workflows/linting.yml runs on PR creation and updates:

• Runs ESLint on all TypeScript files
• Executes in parallel for each project
• Fails if linting errors are found

Build Verification

.github/workflows/building.yml ensures compiled code matches source:

• Cleans and rebuilds TypeScript
• Compares with committed build artifacts
• Fails if builds are out of sync

Adding New Actions

When creating a new shared GitHub Action:

1. Create a new directory for your action:

mkdir my-new-action
cd my-new-action

2. Initialize the project:

bun init

3. Add to GitHub workflows by updating the matrix in both workflow files:

strategy:
  matrix:
    project: ['upstream-tag-on-merge', 'upstream-tag-sync', 'my-new-action']

4. Add to .githooks/pre-commit:

for project in upstream-tag-on-merge upstream-tag-sync my-new-action; do
# ...
done

5. Required scripts:

package.json scripts:

{
  "scripts": {
    "build": "bun install && bun build src/index.ts --outdir=dist --target=node --entry-naming '[name].mjs'",
    "lint": "eslint . \"**/*.ts\"",
    "prepare": "git config core.hooksPath .githooks"
  }
}

Versioning and Releasing

Follow github best practice: https://docs.github.com/en/actions/sharing-automations/creating-actions/about-custom-actions#using-tags-for-release-management