Skip to content

About

Reusable GitHub Actions workflows, a repo template and the scripts that apply them ⚙️

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

github-boilerplate

GitHub release GitHub last commit CI

Reusable GitHub Actions workflows, a repository template and the scripts that apply them: the setup shared by atdr's repositories, written down once. STANDARDS.md explains every decision.

Versioned with semver since 1.0: a change that can turn a passing caller red is a major release. STANDARDS.md says what counts.

What you get

  • Reusable workflows, pinned by tag: Node and Python CI, Markdown lint, conventional commit and PR title checks, a conventions check, and auto-merge for Dependabot's patch and minor bumps.
  • A template: a shared core (issue and PR templates, Dependabot, SECURITY.md, AGENTS.md, lint settings, caller workflows) plus an overlay for Node, Python or TeX.
  • Repository settings as code: squash only merges, security features and a branch ruleset that requires the CI gates.

Usage

Copy the template into a repo, new or existing:

scripts/apply.sh node ~/dev/my-package

Files already in the target are left alone and listed. --force overwrites them, and --diff changes nothing but shows how the repo's copies differ from the template, and which template files it lacks:

scripts/apply.sh node ~/dev/my-package --diff

The caller workflows and configs are copied, not pinned, so a template change reaches a repo only when you copy it across. Run --diff from a checkout of the release the repo pins, or of the latest, to see what to bring over.

For a new LaTeX document, start from atdr/latex-boilerplate ("Use this template"), which holds the document and the local build setup, then run scripts/apply.sh tex on the new repo for the checks it lacks. Files the document already has are left alone.

Then apply the repository settings. It prints what it would change until you pass --apply:

scripts/configure.sh atdr/my-package
scripts/configure.sh atdr/my-package --apply

Or call a reusable workflow directly:

jobs:
  node:
    uses: atdr/github-boilerplate/.github/workflows/[email protected] # x-release-please-version
    secrets:
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

Dependabot's github-actions entry proposes each new tag as a PR.

Development

See AGENTS.md.

License

MIT

About

Reusable GitHub Actions workflows, a repo template and the scripts that apply them ⚙️

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages