CircleCI Open Source Scripts for Usage API

API
1

Hello CircleCI Community!
I’m excited to share that CircleCI has released open-source scripts to help automate the process of using the CircleCI Usage API for generating and retrieving usage reports!

What This Means for You
With these scripts, you now have a streamlined way to access important usage metrics for your CircleCI projects. Whether you’re tracking builds, workflows, or resources, you can quickly generate reports and gain valuable insights to better manage your CI/CD pipelines.

Key Features

  • Automation: Easily automate the retrieval of usage data without manually querying the API each time.
  • Customizable Reports: Tailor the scripts to generate reports that meet your specific needs.
  • Open Source: Contribute to the project or modify it to fit your use case.

Where to Find the Scripts
You can find the open-source scripts and detailed instructions for setup in the CircleCI GitHub repository. Here are a few scripts we’ve put together for users to easily generate a retrieve Usage reports:

How to Get Involved

  • Try It Out: Fork and/or clone the repository and see how the scripts work for your projects.
  • Feedback: We’d love to hear your thoughts! Share your experiences or any suggestions to improve the scripts in this thread or by opening a issue on GitHub.
  • Contributions: If you want to dive deeper, consider contributing to the project or sharing a script of your own. Your expertise could help others in the community!

Why Usage Reports Matter
Tracking usage metrics helps teams understand how their CI/CD pipelines are performing. This data can lead to better decision-making, optimization of resources, and ultimately, smoother workflows.

Let’s leverage this fantastic resource to enhance our CircleCI experience.
If you have any questions or need assistance, feel free to ask here. Happy building!

1 Like