Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 2.36 KB

README.md

File metadata and controls

40 lines (32 loc) · 2.36 KB
Raw

apollo-template

This is a template repo which contains workflow files (see the .github/workflows directory) and configuration files, as well as scripts for installing pre-commit and commit-msg hooks, copying/syncing branch protection rules between repos, and automation of various testing and compliance tasks.

The contained Cargo.toml file is a placeholder and should be modified or replaced in a derived repo.

Scripts

All scripts are contained in the scripts directory. Below follows short descriptions of their use and intended purpose.

  • bpsync.sh - Copies branch protection rules from one (GitHub) repo and branch to another. By default targets the repo that contains it, so that running it without modifications copies the rules from this repo (apollo-template). Run the script without arguments for usage instructions.
  • install-git-hooks.sh - As the name implies, installs git hooks in the current repo. The git hooks installed are the pre-commit and commit-msg hooks. These hooks perform checks/modifications locally that are required to make checks pass on the remote, typically before merging a pull request.
  • pre-commit.sh - The script which is copied and used as the pre-commit hook. Can be run manually.
  • todo-lint.sh - Finds and reports uses of "TODO" (in varying case) in comments and elsewhere in files with associated file extensions (see script source code for specifics).

GitHub Actions

Below follows short descriptions for the CI workflows included in the repository.

  • Conventional commit check (cc.yml) - Checks commit message headers in commit history on pull request to master and ensures that they adhere to the Conventional Commits specification.
  • Check for errors (check.yml) - Runs cargo check to check for errors.
  • Test Coverage (coverage.yml) - Checks test code coverage using tarpaulin.
  • Check licenses and sources (licenses.yml) - Runs cargo-deny to check for incompatible licenses, security advisories, among other things
  • Linting and formatting (lint-format.yml) - An assortment of linting and formatting tools to ensure the code base is consistent, clean and maintainable.
  • Test Suite (test.yml) - A suite of unit and integration tests.