Checks CI/CD overview
Stay organized with collections
Save and categorize content based on your preferences.
Integrating the Checks CLI into your CI/CD pipeline is a straightforward
process. You can use the built-in workflows of popular platforms like GitHub and
GitLab, or customize the integration for other services you use. To learn more
about the benefits of achieving compliance with your CI/CD, check out our blog
post on Google for
Developers.
Typical use-cases for adopting Checks CI/CD
Compliance and developer teams usually adopt Checks in their CI/CD in the
following ways:
Discover issues for developers: A typical approach is using Checks to
expose compliance issues during the development process. You can then expose
the analysis results within your CI/CD platform to increase visibility among
members of your development team. If this is your only intended use-case, it
is recommended that you configure the plugins to not fail the build so that
the development process is not disrupted.
Prevent issues in pre-release builds: Checks can prevent the
introduction of compliance issues in new releases by failing your builds and
providing the analysis results in your CI/Cd platform. Your developers or
DevOps teams can then use the results to decide whether to stop or continue
the build.
Continuous monitoring: Similar to the first use-case, Checks will
capture snapshots of every CI/CD analysis in the Checks Console. This will
allow cross-functional teams to stay up-to-date and receive alerts on
compliance issues.
CI/CD deployment methods
Checks offers several configuration options within your pipeline to fit your
environment and preferences. Each method leverages the same Checks analysis,
ensuring consistent results.
Checks CI/CD plugins
Checks CI/CD plugins are available for GitHub and fastlane (with more coming
soon). Using these plugins is the easiest way to set up and get started, and
include the most common parameters.
Checks CLI binary
If Checks doesn't have a plugin for your specific platform, you can use the
Checks CLI. This offers a familiar
interface for troubleshooting and configuration. The Checks CLI is available for
Linux, Windows, and macOS.
Checks API
For teams with highly customized workflows, Checks offers a robust REST API. Use
it to initiate scans, retrieve reports, and tailor the experience to your unique
requirements. Find more information in the Checks API
documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eIntegrate Checks into your CI/CD pipeline using built-in workflows for platforms like GitHub and GitLab or customize the integration for other services.\u003c/p\u003e\n"],["\u003cp\u003eLeverage Checks to identify compliance issues during development, prevent issues in pre-release builds, and enable continuous monitoring for compliance.\u003c/p\u003e\n"],["\u003cp\u003eChoose from various deployment methods, including CI/CD plugins for GitHub and fastlane, the Checks CLI for other platforms, or the Checks API for custom workflows.\u003c/p\u003e\n"],["\u003cp\u003eAchieve compliance with your CI/CD and learn more about its benefits by checking out the Google for Developers blog post.\u003c/p\u003e\n"]]],[],null,["# Checks CI/CD overview\n\nIntegrating the Checks CLI into your CI/CD pipeline is a straightforward\nprocess. You can use the built-in workflows of popular platforms like GitHub and\nGitLab, or customize the integration for other services you use. To learn more\nabout the benefits of achieving compliance with your CI/CD, check out [our blog\npost on Google for\nDevelopers](https://developers.googleblog.com/2024/04/achieving-privacy-compliance-with-ci-cd-guide.html).\n\nTypical use-cases for adopting Checks CI/CD\n-------------------------------------------\n\nCompliance and developer teams usually adopt Checks in their CI/CD in the\nfollowing ways:\n\n1. **Discover issues for developers**: A typical approach is using Checks to\n expose compliance issues during the development process. You can then expose\n the analysis results within your CI/CD platform to increase visibility among\n members of your development team. If this is your only intended use-case, it\n is recommended that you configure the plugins to not fail the build so that\n the development process is not disrupted.\n\n2. **Prevent issues in pre-release builds**: Checks can prevent the\n introduction of compliance issues in new releases by failing your builds and\n providing the analysis results in your CI/Cd platform. Your developers or\n DevOps teams can then use the results to decide whether to stop or continue\n the build.\n\n3. **Continuous monitoring**: Similar to the first use-case, Checks will\n capture snapshots of every CI/CD analysis in the Checks Console. This will\n allow cross-functional teams to stay up-to-date and receive alerts on\n compliance issues.\n\nCI/CD deployment methods\n------------------------\n\nChecks offers several configuration options within your pipeline to fit your\nenvironment and preferences. Each method leverages the same Checks analysis,\nensuring consistent results.\n\n### Checks CI/CD plugins\n\nChecks CI/CD plugins are available for GitHub and fastlane (with more coming\nsoon). Using these plugins is the easiest way to set up and get started, and\ninclude the most common parameters.\n\n### Checks CLI binary\n\nIf Checks doesn't have a plugin for your specific platform, you can use the\n[Checks CLI](/checks/guide/cli/install-checks-cli). This offers a familiar\ninterface for troubleshooting and configuration. The Checks CLI is available for\nLinux, Windows, and macOS.\n\n### Checks API\n\nFor teams with highly customized workflows, Checks offers a robust REST API. Use\nit to initiate scans, retrieve reports, and tailor the experience to your unique\nrequirements. Find more information in the [Checks API\ndocumentation](/checks/guide/api/quickstart)."]]
