adev

Agnesoft central development repository.

• adev
  • Usage
  • Projects
  • Tools
  • Development
  • Continuous Integration
    • pr
    • adev
  • Known Issues

Usage

Run (use Git Bash on Windows):

./adev.sh

This will show all available actions: building, running various checks, installation of prerequisites & tools etc. E.g.

To build simply run any of:

./adev.sh build
./adev.sh build <toolchain>
./adev.sh build <project> <toolchain>

Available toolchains are:

• clang
• gcc* (default, Linux only)
• msvc (default, Windows only)

*see Known Issues

The binaries will be output to build/<toolchain>.

Projects

Tools

Development

Please refer to contribution.md and style_guide.md for general information.

For development you can use the docker image (preferred) or setup your environment with ./adev.sh install <package> actions or install the tools manually.

Workflow summary:

1. Open and issue
2. Create a branch for that issue
   • observe the naming rules in the style_guide.md, i.e. use [project tag] and name the branch after your issue, including the issue #
3. Work on the branch
   • build & run checks via ./adev.sh
4. Push the branch to GitHub & open PR from your branch to main
5. Merge to main
   • requires 1 approval & all Continous Integration checks to pass

Continuous Integration

The adev is using GitHub Actions. The .adev.sh script actions are run as part of the continuous integration (CI) on every pull request and subsequent merge to main. Most actions are run on Ubuntu based custom docker image that comes with preinstalled prerequisites & tools listed above:

• agnesoft/adev

The docker image is rebuilt if it changes in a PR and the checks are run on such an image. If the PR with a changed dockerfile is merged to main the build will rebuild & push the latest tag of that image to the repository.

Every CI run uploads artifacts (binaries, documentation, coverage report) for usage or inspection even if it failed for easier debugging.

There are two workflows:

pr

• runs on every pull request (pr)
• checks are run only on the diff to the latest main
• skips irrelevant checks.

adev

• runs on every push (merge) to main
• all checks are run fully

Known Issues