Build Tools Orb

An orb with a few handy tools for use in CircleCI Builds. Intended purposes include:

1. Help guide people using CircleCI to solve problems and optimize their configurations.
2. Help surface and collect information so CircleCI engineers can help solve problems.

Usage:

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-report

The commands below are indended to be added as pre-steps for jobs you'd like to investigate.

build-tools/env-info

Generate a report of various kinds of enviroment information. Helpful to find out what packages are install in the enviroment.

build-tools/env-info

build-tools/ios-logs

Save Fastlane logs, Xcode information and iOS simulator crash reports from an iOS job, to be stored as artifacts and inspected later

build-tools/ios-logs

build-tools/memory

Start 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/memory

build-tools/test-results

Create 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-results

Contributing

We 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.