fyisfe / sigridci Goto Github PK

Sigrid helps you to improve your software by measuring your system's code quality, and then compares the results against a benchmark of 10,000 industry systems to give you concrete advice on areas where you can improve.

Sigrid performs code quality checks that have been designed by the Software Improvement Group, which have been used by thousands of development teams over the past 20 years to help improve their software. SIG's approach is based on the ISO 25010 standard for software quality, and has been accredited to ensure alignment with the standard.

Integrating Sigrid's feedback into your development pipeline enables you to fix quality issues right away during your code reviews, instead of having to spot and fix them after the fact. You can access Sigrid's feedback through sigrid-says.com, or directly within your Continuous Integration environment.

Compared to other tools that perform code quality checks, i.e. linters, using Sigrid has a number of advantages:

• Quality guard: Sigrid ensures both the quality of your code and the quality of the system as a whole.
• Pragmatic: Other tools block changes if even a single issue is found. This is not cost-effective. Sigrid CI allows some minor issues as long as the overall quality is acceptable. Code quality should be good, but it doesn't have to be perfect.
• Benchmarked: We rate quality against thousands of other systems, not against theoretical perfection or a subjective target.

We provide specific instructions for integrating Sigrid CI with popular development platforms:

• Integrating Sigrid CI with GitHub Actions
• Integrating Sigrid CI with GitLab
• Integrating Sigrid CI with Bitbucket Pipelines
• Integrating Sigrid CI with Jenkins
• Integrating Sigrid CI with Azure DevOps
• Integrating Sigrid CI with TeamCity
• Integrating Sigrid CI with Mendix QSM on a Mendix Team Server
• Integrating Sigrid CI with Mendix QSM on a GitHub server
• Integrating Sigrid CI with Mendix QSM on a GitLab server
• Integrating Sigrid CI with other/custom CI environments

• Creating authentication tokens for Sigrid CI
• Client script option reference
• Changing the analysis scope configuration
• Adding business context to a system using metadata
• Using Sigrid CI as part of your development workflow
• Frequently asked questions
• Supported technologies
• Sigrid CI demo recording

Most of this documentation refers to our recommended way to integrate Sigrid into your development process: add Sigrid to your pipeline, for both pull requests and publishing code. However, in some cases you might need a more flexible type of integration. The Sigrid API documentation contains an overview of the available data that you can obtain from Sigrid's API and integrate into your workflow.

Feel free to contact SIG's support department for any questions or issues you may have after reading this document, or when using Sigrid or Sigrid CI. Users in Europe can also contact us by phone at +31 20 314 0953.

Copyright Software Improvement Group

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.