Repository Template

Purpose of the project in one sentence or one short paragraph.

This repository:

Repository template for BruzIT projects: MegaLinter and semantic-release callers, release configuration, license and README skeleton.

Features

Feature list or key capabilities; subsections as needed.

This repository:

• README outline with required and optional sections.
• MegaLinter on pull requests and weekly: .mega-linter.yaml, with markdownlint .markdownlint.yaml and zizmor zizmor.yaml configurations.
• semantic-release from Conventional Commits (.releaserc.yaml): version, changelog and GitHub release.

Requirements

Platforms, tools, dependencies, and versions needed.

This repository:

• Platform: GitHub Actions.
• Dependency: BruzIT GitHub Actions and Workflows.

Installation and Setup

How to install and set up the project, step by step.

This repository:

1. Create the repository from this template, by hand ("Use this template") or as code with BruzIT GitHub Organization as Code, which can also manage its settings, rulesets, environments and secrets.

2. Set up the GitHub Apps and environments, provisioned by BruzIT GitHub Organization as Code:

   • release: semantic-release (BruzIT GitHub Actions and Workflows: Use Semantic Release Action).
   • autofix: MegaLinter fixes, GH_AUTOFIX_APP_ID variable and GH_AUTOFIX_APP_PEM_FILE secret (BruzIT GitHub Actions and Workflows: Use MegaLinter Workflow); without it, MegaLinter only reports.

3. Tag the initial commit v0.0.0, so the first release is 0.x instead of 1.0.0 (.releaserc.yaml keeps breaking changes on minor):

   git tag v0.0.0 "$(git rev-list --max-parents=0 HEAD)" && git push origin v0.0.0

4. Make it yours:

   • In every section, replace the general line and the This repository: block with your project's content.
   • Make the first sentence of the description match the repository's GitHub description.
   • Search and replace bruzit/template in the badge URLs; add a workflow badge per required workflow in pipeline order.
   • Delete empty optional sections and the HTML comments.

Usage

Common tasks with minimal examples.

This repository:

Copy this outline; replace each section's content (Installation and Setup, step 4).

Maintenance

How to keep it updated and healthy: updates, upgrades, backup and restore, uninstall.

This repository:

• Bump the @v0 refs on a new major of BruzIT GitHub Actions and Workflows.
• Keep this README aligned with the outline.

Support

Where to ask for help and report problems; for paid products, the service level.

This repository:

Community, best effort; open a GitHub issue.

Development

Local development environment and project layout.

This repository:

Run MegaLinter locally: BruzIT GitHub Actions and Workflows: Linting.

Testing

How to run checks and tests.

This repository:

No unit tests; MegaLinter only (Integration and Deployment).

Integration and Deployment

Workflows that integrate, release, and deploy the project.

This repository:

Workflow	Trigger	Purpose
MegaLinter	Pull request	Lint changed files; required check Required (MegaLinter)
MegaLinter Scheduled	Weekly, Monday 06:00 UTC; manual	Lint the whole codebase
Semantic Release	Push to main	Version, changelog and GitHub release via the shared semantic-release action

Contributing

How to propose changes.

This repository:

Open a pull request to main. Commits follow the Conventional Commits 1.0.0 specification, from which semantic-release sets versions and the changelog automatically.

License and Copyright

License and copyright holder.

This repository:

MIT License: LICENSE
Copyright © 2026 Martin Bružina

References

Related projects and documentation.

This repository:

• BruzIT GitHub Actions and Workflows
• BruzIT GitHub Organization as Code

Stats

Repository figures; stable products add selected usage or customer figures.

This repository:

Metric	Badges
Commits
Issues
Pull requests
Checks on main
Releases
Community