Skip to content

README.md

Latest commit

 

History

History
81 lines (52 loc) · 3.8 KB

README.md

File metadata and controls

81 lines (52 loc) · 3.8 KB

transparent .github transparent

GitHub Release GitHub Workflow Main Status OpenSSF Scorecard

Community health files and configuration for the @bfra-me GitHub organization

 

This repository is used as a template for .github repositories. After creating a new repository using the template, this file should be replaced by .github/README.md.

It contains a collection of reusable workflows and workflow templates for the GitHub Actions ecosystem. Global settings for the @bfra-me organization are defined here.

Reusable Workflows

This repository contains reusable workflows that can be used in other repositories.

renovate.yaml

Renovate is used to manage the dependencies of the repository. This workflow runs a self-hosted Renovate bot (see: @bfra-me/renovate-action to create and update the dependency update PRs.

update-repo-settings.yaml

Update repository settings. Repository settings are defined in .github/settings.yml in the same format used by the Reository Settings App. The workflow uses the elstudio/actions-settings action to update the repository settings.

Development

This repository uses pnpm as the package manager.

Installation

To install dependencies for all packages in the workspace, run:

pnpm install

Workspace Scripts

The following scripts can be run from the root to operate on all packages:

  • Build all actions: pnpm build
  • Run tests: pnpm test
  • Lint code: pnpm lint
  • Type check: pnpm type-check

Adding New Actions

To add a new action to the monorepo:

  1. Create a new directory under .github/actions/
  2. Add a package.json with the action-specific configuration
  3. The workspace will automatically include it
  4. Use the root scripts to build, test, and lint across all actions

Pre-commit Hooks

This repository uses husky and lint-staged to run pre-commit hooks. The hooks will:

  • Run ESLint on staged TypeScript/JavaScript files
  • Format staged files with Prettier
  • Run type checking

The hooks are automatically installed when you run pnpm install. If you need to bypass the hooks for any reason, you can use the --no-verify flag with your git commit:

git commit -m "your message" --no-verify

Releases

Releases are managed using changesets. Renovate dependency updates are captured in changesets by the renovate-changeset workflow.