Skip to main content

HausKeeper

Hauskeeper is our own custom GitHub App/Bot which makes your live easier by automating repetitive repository setup tasks. Whether you're spinning up a new repo or ensuring consistency across projects, HausKeeper has your back.

What Does HausKeeper Do?​

HausKeeper helps us by:

  • Setting up repositories with the configurations we use most often
  • Adding GitHub templates for issues, pull requests, and more to keep our workflows consistent
  • Bypassing Rulesets in GitHub Actions

Think of it as our team's virtual housekeeper for GitHub: cleaning up, organizing, and making sure everything is ready to go!

Why Use HausKeeper?​

  • Saves Time: No more manual setup — we get straight to the real work
  • Keeps Things Consistent: Every repo follows our agreed-upon standards
  • Easy to Use: Once set up, HausKeeper does its job without needing much attention

How to add HausKeeper to a repository​

Adding HausKeeper to a repository is simple! For now, just reach out to the team lead and let them know which repository needs HausKeeper installed. This approach helps us ensure that HausKeeper is performing its tasks as expected while we continue testing and fine-tune its functionality. Once the team lead adds the app, HausKeeper will handle the rest—configuring the repo and applying the necessary templates automatically.

What exactly will happen after installing the app?​

  1. Rulesets Automatically Added

    The following rulesets will be added to the repository:

    • Default Branch Protection: Ensures that the default branch is protected
    • Force Branch Prefix: Enforces standardized prefixes in all new branches created

  2. GitHub Templates Pull Request

    A pull request will automatically be opened adding GitHub Templates (issue templates, pull request templates, etc.). This happens only if no templates exist in the repository yet, ensuring that existing templates are not overwritten.