DevOps guide

This page can be used to understand the DevOps practices adopted by the project.

Build automation

This example project includes features for build automation and dependency management. You can walkthrough command scripts you have in your project, such as how to clean, test, and run the project.

Example Commands for Typical Projects


Continuous integration (CI)

This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the .github/workflows folder). No further setting up required.

Code coverage

As part of CI, this project tracks code coverage as well.

Repository-wide checks

Your CI can include some repository-wide checks. These repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.

Making a release

Here are the steps to create a new release.

Make sure you have the necessary permissions to create a release.
  1. Update the version number.
  2. Tag the repo with the version number.
  3. Create a new release using GitHub.