Open Source Tools
On this page, you will find information about a variety of utilities I've implemented for varying purposes and which I have released as open source software. It is organized on this page into the following sections:
- GitHub Actions for Workflow Automation
- Command-line Utilities (coming soon)
- Docker containers (coming soon)
You can find these open source tools at the following sites:
GitHub Actions for Workflow Automation
While developing software for my research, on occasion I implement tools to automate parts of my workflow. When these seem like they would be useful to others, I share them as open source. Since we use GitHub to develop our research software, our choice for CI/CD and other automation is GitHub Actions, which is GitHub's built in workflow automation framework. I've deployed a website, Open Source GitHub Actions for Workflow Automation, focused specifically on the GitHub Actions that I've implemented for this purpose. A few of these GitHub Actions are the following.
- jacoco-badge-generator: The jacoco-badge-generator parses a jacoco.csv file from a JaCoCo coverage report, computes C0 and C1 coverage percentages from JaCoCo's Instructions and Branches counters, and generates badges for one or both of these (user configurable) to provide an easy to read visual summary of the code coverage of your test cases. The jacoco-badge-generator provides two modes of operation: as a GitHub Action within GitHub's workflow automation framework, as well as a command-line utility that can be used as part of a local build script. The jacoco-badge-generator (as a GitHub Action) can also optionally be used as part of a pull-request check. Specifically, you can configure it to fail the workflow run if coverage decreased relative to prior run, and/or if coverage is below a target threshold.
- user-statistician: The user-statistician GitHub Action generates a detailed visual summary of your activity on GitHub in the form of an SVG, suitable to display on your GitHub Profile README.
- generate-sitemap: The generate-sitemap GitHub Action generates an XML sitemap for a website hosted on GitHub Pages.
- count-action-users: The count-action-users GitHub Action is a meta-action for use by maintainers of GitHub Actions to monitor and report the number of users of the GitHub Actions that they maintain. It generates a Shields endpoint for each Action that they maintain with the count of the number of workflows that use it.
- javadoc-cleanup: The javadoc-cleanup GitHub Action enables creating mobile-friendly and SEO ready, documentation sites by post-processing javadocs in GitHub Actions. The javadoc-cleanup GitHub action is a utility to tidy up javadocs prior to deployment to an API documentation website, assumed hosted on (but not limited to) GitHub Pages.
Top of the page