An orb with a few handy tools for use in CircleCI Builds. Intended purposes include:
- Help guide people using CircleCI to solve problems and optimize their configurations.
- Help surface and collect information so CircleCI engineers can help solve problems.
Reference the orb in your config.yml file. 2.1 Build Processing must be enabled on the project. Check the bottom of your Advanced Settings section in your project settings.
orbs:
build-tools: circleci/[email protected]Following is a selection of the diagnostic-focused commands available in the orb. For full usage guidelines, see the orb registry listing.
Most diagnostic commands are intended to be applied as pre-steps and post-steps (see Reusing Config documentation). Always include build-tools/post-steps to collect results generated in pre-steps.
workflows:
my-workflow:
jobs:
- my-super-neat-job:
pre-steps:
- build-tools/env-info
post-steps:
- build-tools/store-reportThe commands below are indended to be added as pre-steps for jobs you'd like to investigate.
Generate a report of various kinds of enviroment information. Helpful to find out what packages are install in the enviroment.
build-tools/env-infoSave Fastlane logs, Xcode information and iOS simulator crash reports from an iOS job, to be stored as artifacts and inspected later
build-tools/ios-logsStart top as a background process that appends output to a file. Helpful to see memory consumption and process lifecycle over the duration of a job.
build-tools/memoryCreate sample test JUnit XML output for Test Summary report. Helpful if you want to sanity check if test data collection is working.
build-tools/test-resultsWe welcome issues (bugs or feature requests) and pull requests!
For larger discussions, there is also an active community at https://discuss.circleci.com/c/ecosystem/orbs.