├── .codacy.yml ├── .github ├── CODEOWNERS ├── dependabot.yml ├── issue_template.md ├── pull_request_template.md ├── styles │ ├── Microsoft │ │ ├── AMPM.yml │ │ ├── Accessibility.yml │ │ ├── Acronyms.yml │ │ ├── Adverbs.yml │ │ ├── Auto.yml │ │ ├── Avoid.yml │ │ ├── Backend.yml │ │ ├── ComplexWords.yml │ │ ├── Contractions.yml │ │ ├── Dashes.yml │ │ ├── DateFormat.yml │ │ ├── DateNumbers.yml │ │ ├── DateOrder.yml │ │ ├── Ellipses.yml │ │ ├── FirstPerson.yml │ │ ├── Foreign.yml │ │ ├── Gender.yml │ │ ├── GenderBias.yml │ │ ├── GeneralURL.yml │ │ ├── HeadingAcronyms.yml │ │ ├── HeadingColons.yml │ │ ├── HeadingPunctuation.yml │ │ ├── Headings.yml │ │ ├── Hyphens.yml │ │ ├── Negative.yml │ │ ├── Ordinal.yml │ │ ├── OxfordComma.yml │ │ ├── Passive.yml │ │ ├── Percentages.yml │ │ ├── Quotes.yml │ │ ├── RangeFormat.yml │ │ ├── RangeTime.yml │ │ ├── Ranges.yml │ │ ├── Semicolon.yml │ │ ├── SentenceLength.yml │ │ ├── Spacing.yml │ │ ├── Suspended.yml │ │ ├── Terms.yml │ │ ├── URLFormat.yml │ │ ├── Units.yml │ │ ├── Vocab.yml │ │ ├── We.yml │ │ ├── Wordiness.yml │ │ └── meta.json │ ├── alex │ │ ├── Ablist.yml │ │ ├── Condescending.yml │ │ ├── Gendered.yml │ │ ├── LGBTQ.yml │ │ ├── Press.yml │ │ ├── Profanity.yml │ │ ├── README.md │ │ ├── Race.yml │ │ ├── Suicide.yml │ │ └── meta.json │ └── config │ │ └── vocabularies │ │ └── Codacy │ │ └── accept.txt └── workflows │ ├── deleted-files.yml │ ├── enforce-labels.yml │ ├── jira.yml │ ├── mkdocs.yml │ ├── readability.yml │ ├── scheduled.yml │ └── vale.yml ├── .gitignore ├── .gitmodules ├── .htmltest.yml ├── .lycheeignore ├── .markdownlint.json ├── .vale.ini ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── docs ├── account │ ├── emails.md │ ├── images │ │ ├── emails-notifications.png │ │ └── profile.png │ ├── managing-your-profile.md │ └── user-session-management.md ├── assets │ ├── images │ │ ├── codacy-docs-logo.svg │ │ ├── codacy-logo.png │ │ ├── favicon.ico │ │ ├── file-extensions-analyze.png │ │ ├── icon-checklist.svg │ │ ├── icon-checkmark.svg │ │ ├── icon-code.svg │ │ ├── icon-rss-feed.svg │ │ └── icon-user-management.svg │ ├── includes │ │ ├── admin-access-control-info.md │ │ ├── admin-access-info.md │ │ ├── ai-info.md │ │ ├── api-example-pagination-important.md │ │ ├── api-token-warning.md │ │ ├── client-side-tool-instructions.md │ │ ├── cloud.md │ │ ├── coverage-github-accept-permissions.md │ │ ├── coverage-ignore.md │ │ ├── dashboard-api-report-note.md │ │ ├── default-git-provider-settings-tip.md │ │ ├── nav-multistep-quickstart.md │ │ ├── paid.md │ │ ├── service-account-integration.md │ │ ├── status-checks-important.md │ │ └── update-file-extensions-reanalyze.md │ ├── javascripts │ │ └── version-select.js │ └── stylesheets │ │ └── version-select.css ├── codacy-api │ ├── api-tokens.md │ ├── examples │ │ ├── adding-people-to-codacy-programmatically.md │ │ ├── adding-repositories-to-codacy-programmatically.md │ │ ├── creating-repository-api-tokens-programmatically.md │ │ ├── identifying-commits-without-coverage-data.md │ │ ├── obtaining-code-quality-metrics-for-files.md │ │ ├── obtaining-current-issues-in-repositories.md │ │ ├── triggering-dast-scans.md │ │ └── uploading-dast-results.md │ ├── images │ │ ├── codacy-api-tokens-account.png │ │ └── codacy-api-tokens-repository.png │ └── using-the-codacy-api.md ├── codacy-guardrails │ ├── codacy-guardrails-faq.md │ ├── codacy-guardrails-getting-started.md │ ├── codacy-guardrails-how-to-configure-rules.md │ ├── codacy-guardrails-how-to-use.md │ ├── codacy-guardrails-limitations.md │ ├── codacy-guardrails-troubleshooting.md │ └── images │ │ ├── add-codacy-mcp-server.png │ │ ├── analysis-webserver-implementation.png │ │ ├── codacy-extension-activate-cli.png │ │ ├── codacy-extension-add-api-token-workspace.png │ │ ├── codacy-extension-settings.png │ │ ├── code-patterns-config-file.png │ │ ├── code-patterns-configure.png │ │ ├── code-patterns-cs-customize-modal.png │ │ ├── code-patterns-cs-customize.png │ │ ├── code-patterns-toggle-tools.png │ │ ├── code-patterns.png │ │ ├── copilot_agent.png │ │ ├── create-webserver-java.png │ │ ├── install-codacy-extension.png │ │ ├── list-security-issues.png │ │ ├── mcp-server-enabled.png │ │ ├── no-issues-webserver.png │ │ ├── prompt-list-security-issues-repository.png │ │ ├── response-webserver.png │ │ ├── run-mcp-tool-list-security-issues.png │ │ ├── settings-json-vscode.png │ │ └── start-mcp-server-vscode.png ├── coverage-reporter │ ├── alternative-ways-of-running-coverage-reporter.md │ ├── images │ │ ├── coverage-codacy-ui-logs.png │ │ ├── coverage-codacy-ui.png │ │ ├── coverage-pr-commits.png │ │ ├── coverage-pr-commits.svg │ │ ├── coverage-test-integration.png │ │ ├── coverage-validate.png │ │ └── coverage-validate.svg │ ├── index.md │ ├── troubleshooting-coverage-cli-issues.md │ └── uploading-coverage-in-advanced-scenarios.md ├── enterprise-cloud │ ├── github-enterprise-cloud.md │ └── images │ │ ├── Access enterprises.png │ │ ├── Access managmeent access.png │ │ ├── Codacy-Access-Management-revoke-approval.png │ │ ├── Codacy-Access-Management-revoke.png │ │ ├── Codacy-Access-Management.png │ │ ├── Codacy-Enterprise-Organizations.png │ │ ├── Codacy-Enterprise-Seats.png │ │ └── Codacy-Enterprises.png ├── faq │ ├── code-analysis │ │ ├── can-i-bypass-codacy-status-check.md │ │ ├── does-codacy-check-for-dependencies.md │ │ ├── does-codacy-place-limits-on-the-code-analysis.md │ │ ├── how-long-does-it-take-for-my-repository-to-be-analyzed.md │ │ ├── how-to-configure-php-codesniffer-coding-standards.md │ │ ├── how-to-skip-an-analysis.md │ │ ├── images │ │ │ ├── bypass-status-check.png │ │ │ ├── coverage-example-1.png │ │ │ ├── coverage-example-2.png │ │ │ ├── grade_a.png │ │ │ ├── grade_b.png │ │ │ ├── grade_c.png │ │ │ ├── grade_d.png │ │ │ ├── grade_e.png │ │ │ └── grade_f.png │ │ ├── which-metrics-does-codacy-calculate.md │ │ └── why-does-codacy-show-unexpected-coverage-changes.md │ ├── general │ │ ├── .DS_Store │ │ ├── does-codacy-keep-audit-logs.md │ │ ├── how-can-i-change-or-cancel-my-plan.md │ │ ├── how-do-i-allowlist-codacy-cloud-on-my-git-provider.md │ │ ├── how-does-codacy-keep-my-data-secure.md │ │ ├── how-does-codacy-protect-my-privacy.md │ │ ├── how-does-codacy-support-bitbucket-cloud.md │ │ ├── how-does-codacy-support-bitbucket-server.md │ │ ├── how-does-codacy-support-github-enterprise.md │ │ ├── how-does-codacy-support-gitlab-cloud.md │ │ ├── how-does-codacy-support-gitlab-enterprise.md │ │ └── which-platforms-and-technologies-does-codacy-support.md │ ├── repositories │ │ ├── .DS_Store │ │ ├── how-do-i-reanalyze-my-repository.md │ │ ├── i-moved-my-repository-on-the-git-provider.md │ │ ├── i-renamed-my-repository-on-the-git-provider.md │ │ └── images │ │ │ ├── codacy-badge-grade-gray.png │ │ │ ├── reanalyze-repository-commit.png │ │ │ ├── reanalyze-repository-commits-list.png │ │ │ ├── reanalyze-repository-pr.png │ │ │ ├── reanalyze-repository-prs-list.png │ │ │ └── repository-rename.png │ └── troubleshooting │ │ ├── error-line-endings.md │ │ ├── images │ │ ├── duplication-commits.png │ │ ├── duplication-files.png │ │ ├── duplication-metrics-reset.png │ │ ├── error-line-endings.png │ │ ├── git-provider-integration-remove.png │ │ ├── not-a-member-of-the-organization-account.png │ │ ├── not-a-member-of-the-organization-commit.png │ │ ├── organization-refresh-list.png │ │ └── we-no-longer-have-access-to-this-repository-new-key.png │ │ ├── not-a-member-of-the-organization.md │ │ ├── we-no-longer-have-access-to-this-repository.md │ │ ├── why-arent-duplication-metrics-being-calculated.md │ │ ├── why-cant-i-see-my-organization.md │ │ ├── why-did-codacy-stop-commenting-on-pull-requests.md │ │ ├── why-is-my-file-over-150-kb-missing.md │ │ └── why-isnt-my-public-repository-being-analyzed.md ├── getting-started │ ├── adding-a-codacy-badge.md │ ├── codacy-quickstart.md │ ├── configuring-your-repository.md │ ├── images │ │ ├── codacy-badge-example.png │ │ ├── codacy-badge-gray.png │ │ ├── codacy-badge.png │ │ ├── codacy-intellij-plugin-main-view.png │ │ ├── codacy-intellij-plugin-problems-tab.png │ │ ├── codacy-intellij-plugin-sign-in.png │ │ ├── codacy-vscode-extension-analyzed-branch-tab.png │ │ ├── codacy-vscode-extension-important-issues.png │ │ ├── codacy-vscode-extension-inline-coverage.png │ │ ├── codacy-vscode-extension-main-view.png │ │ ├── codacy-vscode-extension-problems-tab.png │ │ ├── codacy-vscode-extension-pull-requests-tab.png │ │ ├── codacy-vscode-extension-sign-in.png │ │ ├── codacy-vscode-extension-status-tab.png │ │ └── revoke-integration.png │ ├── integrating-codacy-with-intellij-ides.md │ ├── integrating-codacy-with-visual-studio-code.md │ ├── integrating-codacy-with-your-git-workflow.md │ ├── supported-languages-and-tools.md │ └── which-permissions-does-codacy-need-from-my-account.md ├── index.md ├── organizations │ ├── audit-logs-for-organizations.md │ ├── changing-your-plan-and-billing.md │ ├── images │ │ ├── Segments-no-sync.png │ │ ├── coding-standard-apply.png │ │ ├── coding-standard-configure-tools.png │ │ ├── coding-standard-create.png │ │ ├── coding-standard-delete.png │ │ ├── coding-standard-edit.png │ │ ├── coding-standard-presets.png │ │ ├── coding-standard-recommended-icon.png │ │ ├── coding-standard-rename.png │ │ ├── coding-standard-select-languages.png │ │ ├── coding-standard-set-default.png │ │ ├── coding-standard-strategy.png │ │ ├── gate-policy-apply.png │ │ ├── gate-policy-codacy-default.png │ │ ├── gate-policy-create.png │ │ ├── gate-policy-delete.png │ │ ├── gate-policy-edit.png │ │ ├── gate-policy-select-values.png │ │ ├── gate-policy-set-default.png │ │ ├── issues-activity.png │ │ ├── open-issues-by-category.png │ │ ├── open-issues-by-severity.png │ │ ├── open-issues-dashboard.png │ │ ├── open-issues-evolution-by-category.png │ │ ├── open-issues-evolution-by-severity.png │ │ ├── open-issues-ranking.png │ │ ├── open-issues-tab-options.png │ │ ├── organization-add-menu.png │ │ ├── organization-add.png │ │ ├── organization-delete.png │ │ ├── organization-join.png │ │ ├── organization-manage-repos-custom-properties-sync.png │ │ ├── organization-manage-repos-custom-properties.png │ │ ├── organization-overview-overall-quality-grouped.png │ │ ├── organization-overview-overall-quality.png │ │ ├── organization-overview-repositories-last-updated.png │ │ ├── organization-people-add-button.png │ │ ├── organization-people-add-modal.png │ │ ├── organization-people-remove.png │ │ ├── organization-people.png │ │ ├── organization-plan-billing-people-accept.png │ │ ├── organization-plan-billing.png │ │ ├── repositories-add.png │ │ ├── repositories-analyzing.png │ │ ├── repositories-follow.png │ │ ├── repositories.png │ │ ├── roles-permissions-organization-manager-assign.png │ │ ├── roles-permissions-repo-management.png │ │ ├── security-risk-management-app-scanning.png │ │ ├── security-risk-management-dependencies-list.png │ │ ├── security-risk-management-dependencies-single.png │ │ ├── security-risk-management-finding-details.png │ │ ├── security-risk-management-finding-ignore.png │ │ ├── security-risk-management-finding-unignore-list.png │ │ ├── security-risk-management-finding-unignore.png │ │ ├── security-risk-management-findings-segments.png │ │ ├── security-risk-management-findings.png │ │ ├── security-risk-management-overview-distribution.png │ │ ├── security-risk-management-overview-history-activity.png │ │ ├── security-risk-management-overview-history-open.png │ │ ├── security-risk-management-overview-open.png │ │ ├── security-risk-management-overview-top-categories.png │ │ ├── security-risk-management-overview-top-risk.png │ │ ├── security-risk-management-overview.png │ │ ├── security-risk-management-segments-overview.png │ │ ├── security-risk-management-slas-configure.png │ │ ├── security-risk-management-slas-modal.png │ │ └── segments-after-sync.png │ ├── integrations │ │ ├── default-git-provider-integration-settings.md │ │ ├── images │ │ │ ├── default-git-provider-settings-apply-all.png │ │ │ ├── default-git-provider-settings.png │ │ │ ├── jira-integration-srm-install.png │ │ │ ├── slack-integration-install.png │ │ │ └── slack-integration-message.png │ │ ├── jira-integration.md │ │ └── slack-integration.md │ ├── issues-metrics.md │ ├── managing-people.md │ ├── managing-repositories.md │ ├── managing-security-and-risk.md │ ├── organization-overview.md │ ├── roles-and-permissions-for-organizations.md │ ├── segments.md │ ├── using-coding-standards.md │ ├── using-gate-policies.md │ └── what-are-organizations.md ├── release-notes │ ├── cloud │ │ ├── cloud-2018-07-23.md │ │ ├── cloud-2018-10-19.md │ │ ├── cloud-2018-11-02.md │ │ ├── cloud-2018-11-16.md │ │ ├── cloud-2019-01-02.md │ │ ├── cloud-2019-02-18-bitbucket-changes.md │ │ ├── cloud-2019-03-29.md │ │ ├── cloud-2019-04-08.md │ │ ├── cloud-2019-05-05.md │ │ ├── cloud-2019-05-20.md │ │ ├── cloud-2019-06-18.md │ │ ├── cloud-2019-08-07.md │ │ ├── cloud-2019-09-05.md │ │ ├── cloud-2019-10-30.md │ │ ├── cloud-2019-11-15.md │ │ ├── cloud-2020-02-github-apps.md │ │ ├── cloud-2020-03-09-nodesecurity-golint-scsslint-removal.md │ │ ├── cloud-2020-04-01-deprecating-http-headers-for-api-tokens.md │ │ ├── cloud-2021-07-03-scheduled-db-maintenance.md │ │ ├── cloud-2021-08.md │ │ ├── cloud-2021-09.md │ │ ├── cloud-2021-10.md │ │ ├── cloud-2021-11-02-legacy-organizations.md │ │ ├── cloud-2021-11.md │ │ ├── cloud-2021-12.md │ │ ├── cloud-2022-01.md │ │ ├── cloud-2022-02-16-pmd-legacy-removal.md │ │ ├── cloud-2022-02.md │ │ ├── cloud-2022-03-31-adding-eslint8.md │ │ ├── cloud-2022-03.md │ │ ├── cloud-2022-04.md │ │ ├── cloud-2022-05.md │ │ ├── cloud-2022-06.md │ │ ├── cloud-2022-07.md │ │ ├── cloud-2022-08.md │ │ ├── cloud-2022-09.md │ │ ├── cloud-2022-10.md │ │ ├── cloud-2022-11.md │ │ ├── cloud-2022-12.md │ │ ├── cloud-2023-01.md │ │ ├── cloud-2023-02.md │ │ ├── cloud-2023-03.md │ │ ├── cloud-2023-04.md │ │ ├── cloud-2023-05.md │ │ ├── cloud-2023-06.md │ │ ├── cloud-2023-07.md │ │ ├── cloud-2023-08.md │ │ ├── cloud-2023-09.md │ │ ├── cloud-2023-10-13-bundler-audit-deprecation.md │ │ ├── cloud-2023-10-25-csslint-jshint-fauxpas-tailor-tslint-deprecation.md │ │ ├── cloud-2023-10.md │ │ ├── cloud-2023-11-13-jira-slack-webhooks-repo-integrations-removal.md │ │ ├── cloud-2023-11-23-new-coverage-engine-status-checks.md │ │ ├── cloud-2023-11.md │ │ ├── cloud-2023-12.md │ │ ├── cloud-2024-01-15-gh-repository-ssh-keys-discontinuation.md │ │ ├── cloud-2024-01.md │ │ ├── cloud-2024-02.md │ │ ├── cloud-2024-03.md │ │ ├── cloud-2024-04.md │ │ ├── cloud-2024-05.md │ │ ├── cloud-2024-06.md │ │ ├── cloud-2024-07.md │ │ ├── cloud-2024-08.md │ │ ├── cloud-2024-09-adding-eslint9-and-pmd7.md │ │ ├── cloud-2024-09.md │ │ ├── cloud-2024-10.md │ │ ├── cloud-2024-11.md │ │ ├── cloud-2024-12.md │ │ ├── cloud-2025-01.md │ │ ├── cloud-2025-02-adding-ruff-lizard.md │ │ ├── cloud-2025-02.md │ │ ├── cloud-2025-03.md │ │ └── cloud-2025-04.md │ ├── images │ │ ├── 2019-02-18-bitbucket-changes.png │ │ ├── 2019-11-15-organizations-authorize.png │ │ ├── 2020-02-github-apps.gif │ │ ├── 2024-01-15-gh-updated-permissions.png │ │ ├── ala-549.png │ │ ├── ala-572.png │ │ ├── ala-593.png │ │ ├── ala-695-status-checks-bitbucket.png │ │ ├── ala-695-status-checks-github.png │ │ ├── ala-695-status-checks-gitlab.png │ │ ├── ala-695-update-status-checks-github.png │ │ ├── ala-824.png │ │ ├── cov-2.png │ │ ├── cy-4196.png │ │ ├── cy-4216.png │ │ ├── cy-4654.png │ │ ├── cy-5533.png │ │ ├── cy-5534.png │ │ ├── cy-5573.png │ │ ├── cy-5580.png │ │ ├── cy-5796.png │ │ ├── cy-5797.png │ │ ├── cy-5876.png │ │ ├── cy-5960.png │ │ ├── cy-6021.png │ │ ├── cy-6336.png │ │ ├── cy-6455.png │ │ ├── cy-6612.png │ │ ├── cy-6855.png │ │ ├── cy-7305.png │ │ ├── hrz-6.png │ │ ├── io-152.png │ │ ├── io-152b.png │ │ ├── io-358.png │ │ ├── io-56.png │ │ ├── io-92.png │ │ ├── pluto-470.png │ │ ├── pluto-484.png │ │ ├── pluto-77.png │ │ ├── tarot-2242.png │ │ └── tarot-2546.png │ ├── index.md │ └── self-hosted │ │ ├── self-hosted-v1.0.0.md │ │ ├── self-hosted-v1.0.1.md │ │ ├── self-hosted-v1.1.0.md │ │ ├── self-hosted-v1.2.0.md │ │ ├── self-hosted-v1.3.0.md │ │ ├── self-hosted-v1.4.0.md │ │ ├── self-hosted-v1.5.0.md │ │ ├── self-hosted-v10.0.0.md │ │ ├── self-hosted-v11.0.0.md │ │ ├── self-hosted-v12.0.0.md │ │ ├── self-hosted-v13.0.0.md │ │ ├── self-hosted-v14.0.0.md │ │ ├── self-hosted-v14.1.1.md │ │ ├── self-hosted-v15.0.0.md │ │ ├── self-hosted-v2.0.0.md │ │ ├── self-hosted-v2.1.0.md │ │ ├── self-hosted-v2.1.1.md │ │ ├── self-hosted-v2.2.0.md │ │ ├── self-hosted-v2.2.1.md │ │ ├── self-hosted-v3.0.0.md │ │ ├── self-hosted-v3.1.0.md │ │ ├── self-hosted-v3.2.0.md │ │ ├── self-hosted-v3.3.0.md │ │ ├── self-hosted-v3.4.0.md │ │ ├── self-hosted-v3.5.0.md │ │ ├── self-hosted-v3.5.1.md │ │ ├── self-hosted-v4.0.0.md │ │ ├── self-hosted-v4.0.1.md │ │ ├── self-hosted-v4.1.0.md │ │ ├── self-hosted-v4.2.0.md │ │ ├── self-hosted-v4.3.0.md │ │ ├── self-hosted-v4.4.0.md │ │ ├── self-hosted-v5.0.0.md │ │ ├── self-hosted-v5.1.0.md │ │ ├── self-hosted-v6.0.0.md │ │ ├── self-hosted-v7.0.0.md │ │ ├── self-hosted-v8.0.0.md │ │ ├── self-hosted-v8.1.0.md │ │ └── self-hosted-v9.0.0.md ├── repositories-configure │ ├── adjusting-quality-gates.md │ ├── adjusting-quality-goals.md │ ├── codacy-configuration-file.md │ ├── configuring-code-patterns.md │ ├── ignoring-files.md │ ├── images │ │ ├── code-patterns-config-file.png │ │ ├── code-patterns-configure.png │ │ ├── code-patterns-cs-customize-modal.png │ │ ├── code-patterns-cs-customize.png │ │ ├── code-patterns-toggle-tools.png │ │ ├── code-patterns.png │ │ ├── disable-language.png │ │ ├── file-extensions.png │ │ ├── ignored-files-configuration-file.png │ │ ├── ignored-files.png │ │ ├── managing-branches-auto-enable.png │ │ ├── managing-branches-sh.png │ │ ├── managing-branches.png │ │ ├── quality-settings-gates.png │ │ ├── quality-settings-goals.png │ │ ├── repository-remove.png │ │ ├── using-submodules-default-add-user-key.png │ │ └── using-submodules-generate-new-user-key.png │ ├── integrations │ │ ├── bitbucket-integration.md │ │ ├── github-integration.md │ │ ├── gitlab-integration.md │ │ ├── images │ │ │ ├── bitbucket-integration-ai-comment.png │ │ │ ├── bitbucket-integration-automatic-summary.png │ │ │ ├── bitbucket-integration-pr-comment.png │ │ │ ├── bitbucket-integration-pr-status.png │ │ │ ├── bitbucket-integration-pr-summary.png │ │ │ ├── bitbucket-integration-refresh.png │ │ │ ├── bitbucket-integration.png │ │ │ ├── github-integration-ai-comment.png │ │ │ ├── github-integration-automatic-summary.png │ │ │ ├── github-integration-coverage-summary.png │ │ │ ├── github-integration-pr-annotation.png │ │ │ ├── github-integration-pr-status.png │ │ │ ├── github-integration-pr-summary.png │ │ │ ├── github-integration-suggest-fixes.png │ │ │ ├── github-integration.png │ │ │ ├── gitlab-integration-ai-comment.png │ │ │ ├── gitlab-integration-pr-comment.png │ │ │ ├── gitlab-integration-pr-status.png │ │ │ ├── gitlab-integration-pr-summary.png │ │ │ ├── gitlab-integration-refresh.png │ │ │ ├── gitlab-integration.png │ │ │ └── post-commit-hook-create.png │ │ └── post-commit-hooks.md │ ├── languages.md │ ├── local-analysis │ │ ├── client-side-tools.md │ │ ├── images │ │ │ ├── client-side-analysis-flow.png │ │ │ ├── client-side-analysis-flow.svg │ │ │ └── run-analysis-through-build-server.png │ │ ├── running-aligncheck.md │ │ ├── running-dartanalyzer.md │ │ ├── running-deadcode.md │ │ ├── running-eslint.md │ │ └── running-spotbugs.md │ ├── managing-branches.md │ ├── removing-your-repository.md │ └── using-submodules.md ├── repositories │ ├── commits.md │ ├── coverage.md │ ├── files.md │ ├── images │ │ ├── commits-detail-quality-overview.png │ │ ├── commits-detail-status.png │ │ ├── commits-detail.png │ │ ├── commits-tab-complexity.png │ │ ├── commits-tab-coverage.png │ │ ├── commits-tab-diff.png │ │ ├── commits-tab-duplication.png │ │ ├── commits-tab-files.png │ │ ├── commits-tab-issues.png │ │ ├── commits-view-logs-modal.png │ │ ├── commits.png │ │ ├── coverage-metrics.png │ │ ├── files-coverage.png │ │ ├── files-details.png │ │ ├── files-duplication.png │ │ ├── files-issues.png │ │ ├── files-search.png │ │ ├── files.png │ │ ├── issues-detail.png │ │ ├── issues-filter.png │ │ ├── issues-fix-issues-button.png │ │ ├── issues-fix-issues-modal.png │ │ ├── issues-menu.png │ │ ├── issues-unignore.png │ │ ├── issues.png │ │ ├── low-covered-files-tables.png │ │ ├── open-pull-requests-widget.png │ │ ├── pull-requests-detail-quality-overview.png │ │ ├── pull-requests-detail-status.png │ │ ├── pull-requests-detail.png │ │ ├── pull-requests-tab-commits.png │ │ ├── pull-requests-tab-complexity.png │ │ ├── pull-requests-tab-coverage.png │ │ ├── pull-requests-tab-diff.png │ │ ├── pull-requests-tab-duplication.png │ │ ├── pull-requests-tab-files.png │ │ ├── pull-requests-tab-issues.png │ │ ├── pull-requests-view-logs-modal.png │ │ ├── pull-requests.png │ │ ├── repository-dashboard-coverage.png │ │ ├── repository-dashboard-issues-breakdown.png │ │ ├── repository-dashboard-open-pull-requests.png │ │ ├── repository-dashboard-quality-evolution.png │ │ └── repository-dashboard.png │ ├── issues.md │ ├── pull-requests.md │ └── repository-dashboard.md └── special-thanks.md ├── mkdocs.yml ├── requirements.txt └── tools ├── README.md ├── check-security-tools.py ├── check-supported-tools.py ├── find-unused-images.sh ├── get-security-patterns.py ├── get-tool-descriptions.py ├── list-last-modified.py ├── list-tool-short-names.sh └── requirements.txt /.codacy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | exclude_paths: 3 | - ".github/styles/**" 4 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @codacy/techwriters 2 | /docs/release-notes/self-hosted/ @codacy/support @codacy/qa 3 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | 4 | # Maintain dependencies for GitHub Actions 5 | - package-ecosystem: "github-actions" 6 | directory: "/" 7 | schedule: 8 | interval: "weekly" 9 | 10 | # Maintain dependencies for pip 11 | - package-ecosystem: "pip" 12 | directory: "/" 13 | schedule: 14 | interval: "weekly" 15 | -------------------------------------------------------------------------------- /.github/issue_template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Documentation feedback 3 | about: Provide us with your feedback to help improve Codacy's documentation 4 | title: '' 5 | labels: '' 6 | assignees: 7 | 8 | --- 9 | 10 | **Type of feedback** 11 | 12 | - [ ] Bug or incorrect information 13 | - [ ] Missing information 14 | - [ ] Outdated information 15 | - [ ] Enhancement 16 | - [ ] Other 17 | 18 | **Feedback** 19 | 20 | 21 | 22 | **Affected pages** 23 | This feedback applies to the following documentation pages / URLs: 24 | 25 | 26 | 27 | **Additional context** 28 | If applicable, provide any other context or information that could be useful in updating the documentation: 29 | 30 | 31 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | ### :eyes: Live preview 7 | 8 | 9 | ### :construction: To do 10 | - [ ] If relevant, include the Jira issue key at the end of the pull request title 11 | - [ ] Perform a self-review of the changes 12 | - [ ] Fix any issues reported by the CI/CD 13 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/AMPM.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: Use 'AM' or 'PM' (preceded by a space). 3 | link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms 4 | level: error 5 | nonword: true 6 | tokens: 7 | - '\d{1,2}[AP]M' 8 | - '\d{1,2} ?[ap]m' 9 | - '\d{1,2} ?[aApP]\.[mM]\.' 10 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Accessibility.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't use language (such as '%s') that defines people by their disability." 3 | link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms 4 | level: suggestion 5 | ignorecase: true 6 | tokens: 7 | - a victim of 8 | - able-bodied 9 | - affected by 10 | - an epileptic 11 | - crippled 12 | - disabled 13 | - dumb 14 | - handicapped 15 | - handicaps 16 | - healthy 17 | - lame 18 | - maimed 19 | - missing a limb 20 | - mute 21 | - normal 22 | - sight-impaired 23 | - stricken with 24 | - suffers from 25 | - vision-impaired 26 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Acronyms.yml: -------------------------------------------------------------------------------- 1 | extends: conditional 2 | message: "'%s' has no definition." 3 | link: https://docs.microsoft.com/en-us/style-guide/acronyms 4 | level: suggestion 5 | ignorecase: false 6 | # Ensures that the existence of 'first' implies the existence of 'second'. 7 | first: '\b([A-Z]{3,5})\b' 8 | second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' 9 | # ... with the exception of these: 10 | exceptions: 11 | - API 12 | - ASP 13 | - CLI 14 | - CPU 15 | - CSS 16 | - CSV 17 | - DEBUG 18 | - DOM 19 | - DPI 20 | - FAQ 21 | - GCC 22 | - GDB 23 | - GET 24 | - GPU 25 | - GTK 26 | - GUI 27 | - HTML 28 | - HTTP 29 | - HTTPS 30 | - IDE 31 | - JAR 32 | - JSON 33 | - JSX 34 | - LESS 35 | - LLDB 36 | - NET 37 | - NOTE 38 | - NVDA 39 | - OSS 40 | - PATH 41 | - PDF 42 | - PHP 43 | - POST 44 | - RAM 45 | - REPL 46 | - RSA 47 | - SCM 48 | - SCSS 49 | - SDK 50 | - SQL 51 | - SSH 52 | - SSL 53 | - SVG 54 | - TBD 55 | - TCP 56 | - TODO 57 | - URI 58 | - URL 59 | - USB 60 | - UTF 61 | - XML 62 | - XSS 63 | - YAML 64 | - ZIP 65 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Auto.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "In general, don't hyphenate '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto 4 | ignorecase: true 5 | level: error 6 | action: 7 | name: convert 8 | params: 9 | - simple 10 | tokens: 11 | - 'auto-\w+' 12 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Avoid.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't use '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide 4 | ignorecase: true 5 | level: error 6 | tokens: 7 | - abortion 8 | - and so on 9 | - and/or 10 | - app developer 11 | - app(?:lication)? file 12 | - application developer 13 | - application program 14 | - applications developer 15 | - as well as 16 | - ask 17 | - backbone 18 | - backend 19 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Backend.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Use '%s' instead of '%s'." 3 | level: warning 4 | link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/b/back-end 5 | # Use 'back end' (noun) or 'back-end' (adj). 6 | pos: 'back-end/NN|backend/(?:JJ|NN)|back/\w+ end/JJ|back/(?:JJ|RB) end/\w+' 7 | ignorecase: true 8 | action: 9 | name: replace 10 | swap: 11 | back-end: back end 12 | back end: back-end 13 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Contractions.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Use '%s' instead of '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions 4 | level: error 5 | ignorecase: true 6 | action: 7 | name: replace 8 | swap: 9 | are not: aren't 10 | cannot: can't 11 | could not: couldn't 12 | did not: didn't 13 | do not: don't 14 | does not: doesn't 15 | has not: hasn't 16 | have not: haven't 17 | how is: how's 18 | is not: isn't 19 | it is: it's 20 | should not: shouldn't 21 | that is: that's 22 | they are: they're 23 | was not: wasn't 24 | we are: we're 25 | we have: we've 26 | were not: weren't 27 | what is: what's 28 | when is: when's 29 | where is: where's 30 | will not: won't 31 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Dashes.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Remove the spaces around '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes 4 | ignorecase: true 5 | nonword: true 6 | level: error 7 | action: 8 | name: edit 9 | params: 10 | - remove 11 | - ' ' 12 | tokens: 13 | - '\s[—–]\s' 14 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/DateFormat.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: Use 'July 31, 2016' format, not '%s'. 3 | link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms 4 | ignorecase: true 5 | level: error 6 | nonword: true 7 | tokens: 8 | - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' 9 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/DateNumbers.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't use ordinal numbers for dates." 3 | link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates 4 | level: error 5 | nonword: true 6 | ignorecase: true 7 | raw: 8 | - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* 9 | tokens: 10 | - first 11 | - second 12 | - third 13 | - fourth 14 | - fifth 15 | - sixth 16 | - seventh 17 | - eighth 18 | - ninth 19 | - tenth 20 | - eleventh 21 | - twelfth 22 | - thirteenth 23 | - fourteenth 24 | - fifteenth 25 | - sixteenth 26 | - seventeenth 27 | - eighteenth 28 | - nineteenth 29 | - twentieth 30 | - twenty-first 31 | - twenty-second 32 | - twenty-third 33 | - twenty-fourth 34 | - twenty-fifth 35 | - twenty-sixth 36 | - twenty-seventh 37 | - twenty-eighth 38 | - twenty-ninth 39 | - thirtieth 40 | - thirty-first 41 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/DateOrder.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Always spell out the name of the month." 3 | link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates 4 | ignorecase: true 5 | level: error 6 | nonword: true 7 | tokens: 8 | - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' 9 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Ellipses.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "In general, don't use an ellipsis." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses 4 | nonword: true 5 | level: warning 6 | action: 7 | name: remove 8 | tokens: 9 | - '\.\.\.' 10 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/FirstPerson.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Use first person (such as '%s') sparingly." 3 | link: https://docs.microsoft.com/en-us/style-guide/grammar/person 4 | ignorecase: true 5 | level: warning 6 | nonword: true 7 | tokens: 8 | - (?:^|\s)I\s 9 | - (?:^|\s)I,\s 10 | - \bI'm\b 11 | - \bme\b 12 | - \bmy\b 13 | - \bmine\b 14 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Foreign.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Use '%s' instead of '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words 4 | ignorecase: true 5 | level: error 6 | nonword: true 7 | action: 8 | name: replace 9 | swap: 10 | '\b(?:eg|e\.g\.)[\s,]': for example 11 | '\b(?:ie|i\.e\.)[\s,]': that is 12 | 13 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Gender.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't use '%s'." 3 | link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender 4 | level: error 5 | ignorecase: true 6 | tokens: 7 | - he/she 8 | - s/he 9 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/GeneralURL.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "For a general audience, use 'address' rather than 'URL'." 3 | link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses 4 | level: warning 5 | action: 6 | name: replace 7 | params: 8 | - URL 9 | - address 10 | tokens: 11 | - URL 12 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/HeadingAcronyms.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Avoid using acronyms in a title or heading." 3 | link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings 4 | level: warning 5 | scope: heading 6 | tokens: 7 | - '[A-Z]{2,4}' 8 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/HeadingColons.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Capitalize '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons 4 | nonword: true 5 | level: error 6 | scope: heading 7 | tokens: 8 | - ':\s[a-z]' 9 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/HeadingPunctuation.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't use end punctuation in headings." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods 4 | nonword: true 5 | level: warning 6 | scope: heading 7 | action: 8 | name: edit 9 | params: 10 | - remove 11 | - '.?!' 12 | tokens: 13 | - '[a-z0-9][.?!](?:\s|$)' 14 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Headings.yml: -------------------------------------------------------------------------------- 1 | extends: capitalization 2 | message: "'%s' should use sentence-style capitalization." 3 | link: https://docs.microsoft.com/en-us/style-guide/capitalization 4 | level: suggestion 5 | scope: heading 6 | match: $sentence 7 | indicators: 8 | - ':' 9 | exceptions: 10 | - Azure 11 | - CLI 12 | - Code 13 | - Cosmos 14 | - Docker 15 | - Emmet 16 | - I 17 | - Kubernetes 18 | - Linux 19 | - macOS 20 | - Marketplace 21 | - MongoDB 22 | - REPL 23 | - Studio 24 | - TypeScript 25 | - URLs 26 | - Visual 27 | - VS 28 | - Windows 29 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Hyphens.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' doesn't need a hyphen." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens 4 | level: warning 5 | ignorecase: false 6 | nonword: true 7 | action: 8 | name: edit 9 | params: 10 | - replace 11 | - '-' 12 | - ' ' 13 | tokens: 14 | - '\s[^\s-]+ly-' 15 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Negative.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Form a negative number with an en dash, not a hyphen." 3 | link: https://docs.microsoft.com/en-us/style-guide/numbers 4 | nonword: true 5 | level: error 6 | action: 7 | name: edit 8 | params: 9 | - replace 10 | - '-' 11 | - '–' 12 | tokens: 13 | - '\s-\d+\s' 14 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Ordinal.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't add -ly to an ordinal number." 3 | link: https://docs.microsoft.com/en-us/style-guide/numbers 4 | level: error 5 | action: 6 | name: edit 7 | params: 8 | - trim 9 | - ly 10 | tokens: 11 | - firstly 12 | - secondly 13 | - thirdly 14 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/OxfordComma.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Use the Oxford comma in '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas 4 | scope: sentence 5 | level: warning 6 | tokens: 7 | - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' 8 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Percentages.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Use a numeral plus the units." 3 | link: https://docs.microsoft.com/en-us/style-guide/numbers 4 | nonword: true 5 | level: error 6 | tokens: 7 | - '\b[a-zA-z]+\spercent\b' 8 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Quotes.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: 'Punctuation should be inside the quotes.' 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks 4 | level: error 5 | nonword: true 6 | tokens: 7 | - '["“][^"”“]+["”][.,]' 8 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/RangeFormat.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Use an en dash in a range of numbers." 3 | link: https://docs.microsoft.com/en-us/style-guide/numbers 4 | nonword: true 5 | level: error 6 | action: 7 | name: edit 8 | params: 9 | - replace 10 | - '-' 11 | - '–' 12 | tokens: 13 | - '\b\d+\s?[-]\s?\d+\b' 14 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/RangeTime.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Use 'to' instead of a dash in '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/numbers 4 | nonword: true 5 | level: error 6 | action: 7 | name: edit 8 | params: 9 | - replace 10 | - '[-–]' 11 | - 'to' 12 | tokens: 13 | - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' 14 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Ranges.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "In most cases, use 'from' or 'through' to describe a range of numbers." 3 | link: 'https://docs.microsoft.com/en-us/style-guide/numbers' 4 | nonword: true 5 | level: warning 6 | tokens: 7 | - '\b\d+\s?[-–]\s?\d+\b' 8 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Semicolon.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Try to simplify this sentence." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons 4 | nonword: true 5 | scope: sentence 6 | level: suggestion 7 | tokens: 8 | - ';' 9 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/SentenceLength.yml: -------------------------------------------------------------------------------- 1 | extends: occurrence 2 | message: "Try to keep sentences short (< 30 words)." 3 | scope: sentence 4 | level: suggestion 5 | max: 30 6 | token: \b(\w+)\b 7 | 8 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Spacing.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' should have one space." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods 4 | level: error 5 | nonword: true 6 | tokens: 7 | - '[a-z][.?!] {2,}[A-Z]' 8 | - '[a-z][.?!][A-Z]' 9 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Suspended.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't use '%s' unless space is limited." 3 | link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens 4 | ignorecase: true 5 | level: warning 6 | tokens: 7 | - '\w+- and \w+-' 8 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Terms.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Prefer '%s' over '%s'." 3 | level: warning 4 | ignorecase: true 5 | action: 6 | name: replace 7 | swap: 8 | '(?:drive C:|drive C>|C: drive)': drive C 9 | '(?:internet bot|web robot)s?': bot(s) 10 | '(?:microsoft cloud|the cloud)': cloud 11 | '(?:mobile|smart) ?phone': phone 12 | '24/7': every day 13 | 'audio(?:-| )book': audiobook 14 | 'back(?:-| )light': backlight 15 | 'chat ?bots?': chatbot(s) 16 | adaptor: adapter 17 | administrate: administer 18 | afterwards: afterward 19 | alphabetic: alphabetical 20 | alphanumerical: alphanumeric 21 | anti-aliasing: antialiasing 22 | anti-malware: antimalware 23 | anti-spyware: antispyware 24 | anti-virus: antivirus 25 | appendixes: appendices 26 | artificial intelligence: artificial intelligence 27 | assembler: assembly language 28 | bpp: bpp 29 | bps: bps 30 | caap: CaaP 31 | conversation-as-a-platform: conversation as a platform 32 | eb: EB 33 | gb: GB 34 | gbps: Gbps 35 | kb: KB 36 | keypress: keystroke 37 | mb: MB 38 | pb: PB 39 | tb: TB 40 | zb: ZB 41 | viz: namely 42 | ergo: therefore 43 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/URLFormat.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Use '%s' instead of '%s'." 3 | ignorecase: true 4 | level: error 5 | action: 6 | name: replace 7 | swap: 8 | URL for: URL of 9 | an URL: a URL 10 | 11 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Units.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't spell out the number in '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms 4 | level: error 5 | raw: 6 | - '[a-zA-Z]+\s' 7 | tokens: 8 | - '(?:centi|milli)?meters' 9 | - '(?:kilo)?grams' 10 | - '(?:kilo)?meters' 11 | - '(?:mega)?pixels' 12 | - cm 13 | - inches 14 | - lb 15 | - miles 16 | - pounds 17 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/Vocab.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Verify your use of '%s' with the A-Z word list." 3 | link: 'https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/abort-abortion' 4 | level: suggestion 5 | ignorecase: true 6 | tokens: 7 | - above 8 | - accessible 9 | - actionable 10 | - against 11 | - alarm 12 | - alert 13 | - alias 14 | - allows? 15 | - assure 16 | - author 17 | - avg 18 | - ensure 19 | - he 20 | - insure 21 | - she 22 | - sample 23 | - beta 24 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/We.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Try to avoid using first-person plural like '%s'." 3 | link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural 4 | level: warning 5 | ignorecase: true 6 | tokens: 7 | - we 8 | - we'(?:ve|re) 9 | - ours? 10 | - us 11 | - let's 12 | -------------------------------------------------------------------------------- /.github/styles/Microsoft/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "feed": "https://github.com/errata-ai/Microsoft/releases.atom", 3 | "vale_version": ">=1.0.0" 4 | } 5 | -------------------------------------------------------------------------------- /.github/styles/alex/Condescending.yml: -------------------------------------------------------------------------------- 1 | --- 2 | extends: existence 3 | message: Using '%s' may come across as condescending. 4 | link: https://css-tricks.com/words-avoid-educational-writing/ 5 | level: error 6 | ignorecase: true 7 | tokens: 8 | - obvious 9 | - obviously 10 | - simple 11 | - simply 12 | - easy 13 | - easily 14 | - of course 15 | - clearly 16 | - everyone knows 17 | -------------------------------------------------------------------------------- /.github/styles/alex/Press.yml: -------------------------------------------------------------------------------- 1 | --- 2 | extends: substitution 3 | message: Consider using '%s' instead of '%s'. 4 | ignorecase: true 5 | level: warning 6 | action: 7 | name: replace 8 | swap: 9 | islamist: muslim|person of Islamic faith|fanatic|zealot|follower of islam|follower 10 | of the islamic faith 11 | islamists: muslims|people of Islamic faith|fanatics|zealots 12 | -------------------------------------------------------------------------------- /.github/styles/alex/README.md: -------------------------------------------------------------------------------- 1 | Based on [alex](https://github.com/get-alex/alex). 2 | 3 | > Catch insensitive, inconsiderate writing 4 | 5 | ``` 6 | (The MIT License) 7 | 8 | Copyright (c) 2015 Titus Wormer 9 | 10 | Permission is hereby granted, free of charge, to any person obtaining a copy 11 | of this software and associated documentation files (the "Software"), to deal 12 | in the Software without restriction, including without limitation the rights 13 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 14 | copies of the Software, and to permit persons to whom the Software is 15 | furnished to do so, subject to the following conditions: 16 | 17 | The above copyright notice and this permission notice shall be included in 18 | all copies or substantial portions of the Software. 19 | 20 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 21 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 22 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 23 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 24 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 25 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 26 | THE SOFTWARE. 27 | ``` 28 | -------------------------------------------------------------------------------- /.github/styles/alex/Suicide.yml: -------------------------------------------------------------------------------- 1 | --- 2 | extends: substitution 3 | message: When referring to a person, consider using '%s' instead of '%s'. 4 | ignorecase: true 5 | level: warning 6 | action: 7 | name: replace 8 | swap: 9 | commit suicide: die by suicide 10 | committed suicide: died by suicide 11 | complete suicide: die by suicide 12 | completed suicide: died by suicide 13 | epidemic of suicides: rise in suicides 14 | failed attempt: suicide attempt|attempted suicide 15 | failed suicide: suicide attempt|attempted suicide 16 | hang: the app froze|the app stopped responding|the app stopped responding to events|the 17 | app became unresponsive 18 | hanged: the app froze|the app stopped responding|the app stopped responding to events|the 19 | app became unresponsive 20 | successful suicide: die by suicide 21 | suicide epidemic: rise in suicides 22 | suicide failure: suicide attempt|attempted suicide 23 | suicide note: a note from the deceased 24 | suicide pact: rise in suicides 25 | -------------------------------------------------------------------------------- /.github/styles/alex/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "feed": "https://github.com/errata-ai/alex/releases.atom", 3 | "vale_version": ">=1.0.0" 4 | } -------------------------------------------------------------------------------- /.github/styles/config/vocabularies/Codacy/accept.txt: -------------------------------------------------------------------------------- 1 | aligncheck 2 | autofix 3 | autoremediate 4 | allowlist 5 | Atlassian 6 | autovacuum 7 | Ameba 8 | Bandit 9 | Bitbucket 10 | Bitnami 11 | Brakeman 12 | bundler-audit 13 | Checkov 14 | Checkstyle 15 | Clang-Tidy 16 | CloudFormation 17 | cloc 18 | Cobertura 19 | Codacy 20 | CodeNarc 21 | CoffeeLint 22 | config 23 | [Cc]overable 24 | Cppcheck 25 | Credo 26 | CSSLint 27 | Ctrl 28 | [Cc]yclomatic 29 | dartanalyzer 30 | deadcode 31 | Dependabot 32 | detekt 33 | Dockerfile 34 | endif 35 | ESLint 36 | Flawfinder 37 | Fluentd 38 | GitHub 39 | GitLab 40 | Gocyclo 41 | Gosec 42 | Gradle 43 | Grafana 44 | Gravatar 45 | Hadolint 46 | Hardcoded 47 | hostname 48 | hotfix 49 | Jira 50 | jq 51 | jscpd 52 | JSHint 53 | JSP 54 | markdownlint 55 | monorepo 56 | namespace 57 | OAuth 58 | onboarding 59 | PHP_CodeSniffer 60 | PHPUnit 61 | plaintext 62 | PMD 63 | Prospector 64 | Promtail 65 | PSScriptAnalyser 66 | PVC 67 | Pylint 68 | remark-lint 69 | Revive 70 | Rollout 71 | rollout 72 | RuboCop 73 | sbt 74 | Scalameta 75 | Scalastyle 76 | SCSSLint 77 | Semgrep 78 | Serverless 79 | severities 80 | ShellCheck 81 | SonarC# 82 | SonarVB 83 | SpotBugs 84 | SQLint 85 | Staticcheck 86 | Stylelint 87 | SwiftLint 88 | Tailor 89 | Trivy 90 | tooltip 91 | TSLint 92 | TSQLLint 93 | unassigns 94 | unfollow 95 | vacuumdb 96 | Visualforce 97 | VSCode 98 | Xcode 99 | webserver 100 | -------------------------------------------------------------------------------- /.github/workflows/deleted-files.yml: -------------------------------------------------------------------------------- 1 | name: Deleted files 2 | 3 | on: 4 | pull_request: 5 | branches: 6 | master 7 | 8 | jobs: 9 | list-deleted-files: 10 | runs-on: ubuntu-latest 11 | name: Detect deleted files 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v4 15 | 16 | - name: Get changed docs md files 17 | id: changed-files 18 | uses: tj-actions/changed-files@v45 19 | with: 20 | files: docs/**/*.md 21 | 22 | - name: Format list of deleted files 23 | id: format-output 24 | env: 25 | ORIGINAL_DELETED: '${{ steps.changed-files.outputs.deleted_files }}' 26 | ORIGINAL_RENAMED: '${{ steps.changed-files.outputs.renamed_files }}' 27 | run: | 28 | echo "FORMATTED_DELETED=$(echo $ORIGINAL_DELETED | sed 's/ /`
`/g')" >> $GITHUB_OUTPUT 29 | echo "FORMATTED_RENAMED=$(echo $ORIGINAL_RENAMED | sed 's/ /`
`/g')" >> $GITHUB_OUTPUT 30 | 31 | - name: Comment PR if there are deleted files 32 | if: steps.changed-files.outputs.any_deleted == 'true' 33 | uses: thollander/actions-comment-pull-request@v2 34 | with: 35 | message: | 36 | ## Remember to add redirects 37 | ${{ steps.format-output.outputs.FORMATTED_DELETED != '' && format('This PR **deletes** one or more `md` files:
`{0}`
', steps.format-output.outputs.FORMATTED_DELETED) || '' }} 38 | ${{ steps.format-output.outputs.FORMATTED_RENAMED != '' && format('This PR **renames** one or more `md` files:
`{0}`
', steps.format-output.outputs.FORMATTED_RENAMED) || '' }} 39 | Remember to append the appropriate redirects in `mkdocs.yml` under `plugins.redirects.redirect_maps`. 40 | comment_tag: deleted-files-reminder 41 | -------------------------------------------------------------------------------- /.github/workflows/enforce-labels.yml: -------------------------------------------------------------------------------- 1 | name: Enforce labels 2 | 3 | on: 4 | pull_request: 5 | types: [opened, reopened, synchronize, labeled, unlabeled] 6 | 7 | jobs: 8 | enforce-label: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: yogevbd/enforce-label-action@2.2.2 12 | with: 13 | BANNED_LABELS: "don't merge" 14 | -------------------------------------------------------------------------------- /.github/workflows/readability.yml: -------------------------------------------------------------------------------- 1 | name: Report readability 2 | 3 | # This action only works on pull request events 4 | on: pull_request 5 | 6 | jobs: 7 | report-readability: 8 | name: Report readability 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Checkout repo with history 12 | uses: actions/checkout@v4 13 | with: 14 | fetch-depth: 0 15 | - uses: Rebilly/lexi@v2 16 | with: 17 | github-token: ${{ secrets.GITHUB_TOKEN }} 18 | glob: 'docs/**/*.md' -------------------------------------------------------------------------------- /.github/workflows/vale.yml: -------------------------------------------------------------------------------- 1 | name: Vale 2 | 3 | on: 4 | pull_request 5 | 6 | jobs: 7 | vale: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout code 11 | uses: actions/checkout@v4 12 | with: 13 | token: ${{ secrets.GITHUB_TOKEN }} 14 | submodules: false 15 | 16 | - name: Vale 17 | uses: errata-ai/vale-action@reviewdog 18 | with: 19 | filter_mode: added 20 | debug: true 21 | fail_on_error: false 22 | env: 23 | # Required 24 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # MkDocs build dir 2 | site/ 3 | 4 | # OS generated files 5 | .DS_Store 6 | 7 | # IDE files 8 | .vscode 9 | .metals 10 | .idea 11 | 12 | # Backup files 13 | *.swp 14 | *.bak 15 | *.tmp 16 | *~ 17 | 18 | # Auxiliary tool outputs 19 | tools/*.csv 20 | 21 | .codacy 22 | 23 | #Ignore vscode AI rules 24 | .github/copilot-instructions.md 25 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "submodules/chart"] 2 | path = submodules/chart 3 | url = https://github.com/codacy/chart 4 | branch = master 5 | [submodule "submodules/codacy-mkdocs-material"] 6 | path = submodules/codacy-mkdocs-material 7 | url = https://github.com/codacy/codacy-mkdocs-material 8 | -------------------------------------------------------------------------------- /.htmltest.yml: -------------------------------------------------------------------------------- 1 | DirectoryPath: "site/" 2 | CheckExternal: false 3 | IgnoreDirectoryMissingTrailingSlash: true 4 | -------------------------------------------------------------------------------- /.lycheeignore: -------------------------------------------------------------------------------- 1 | # Ignore internal links 2 | ^[^h].*$ 3 | 4 | # Ignore links to internal repositories (found in comments) 5 | https:[\\/][\\/]github\.com[\\/]codacy[\\/]codacy-tools[\\/].* 6 | 7 | # Ignore dynamic links 8 | https:[\\/][\\/]github\.com[\\/]codacy[\\/]codacy-analysis-cli[\\/]releases[\\/]tag[\\/]self-hosted- 9 | https:[\\/][\\/]github\.com[\\/]codacy[\\/]codacy-coverage-reporter[\\/]releases[\\/]tag[\\/]self-hosted- 10 | https:[\\/][\\/]github\.com[\\/]codacy[\\/]codacy-coverage-reporter[\\/]releases[\\/]tag[\\/] 11 | -------------------------------------------------------------------------------- /.markdownlint.json: -------------------------------------------------------------------------------- 1 | { 2 | "ignore_front_matter": true, 3 | "all": true, 4 | "MD003": { 5 | "style": "atx" 6 | }, 7 | "MD004": { 8 | "style": "dash" 9 | }, 10 | "MD007": { 11 | "indent": 4 12 | }, 13 | "MD013": false, 14 | "MD029": { 15 | "style": "one" 16 | }, 17 | "MD030": { 18 | "ul_single": 3, 19 | "ol_single": 2, 20 | "ul_multi": 3, 21 | "ol_multi": 2 22 | }, 23 | "MD033": false, 24 | "MD035": { 25 | "style": "---" 26 | }, 27 | "MD044": false, 28 | "MD046": false, 29 | "MD048": { 30 | "style": "backtick" 31 | }, 32 | "MD051": false 33 | } 34 | -------------------------------------------------------------------------------- /.vale.ini: -------------------------------------------------------------------------------- 1 | StylesPath = .github/styles 2 | MinAlertLevel = warning 3 | SkippedScopes = style 4 | IgnoredScopes = code, strong, tt 5 | IgnoredClasses = skip-vale 6 | Vocab = Codacy 7 | 8 | [*.md] 9 | # Ignore Markdown includes and bare URLs 10 | TokenIgnores = ({%\s*include.*%})|(<(?!!--).*>)|({:.*})|({{.*}}) 11 | BlockIgnores = (?s){%\s*include.*%} 12 | 13 | BasedOnStyles = Vale, Microsoft, alex 14 | 15 | Microsoft.Avoid = NO 16 | Microsoft.FirstPerson = suggestion 17 | Microsoft.GeneralURL = NO 18 | Microsoft.HeadingAcronyms = NO 19 | Microsoft.HeadingPunctuation = . 20 | Microsoft.HeadingColons = NO 21 | Microsoft.We = NO 22 | 23 | alex.Profanity = suggestion 24 | alex.Ablist = suggestion 25 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Code of conduct 2 | 3 | This project follows the [Codacy Community Code of Conduct](https://community.codacy.com/t/code-of-conduct/19). 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2022 Codacy 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License. 14 | -------------------------------------------------------------------------------- /docs/account/images/emails-notifications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/account/images/emails-notifications.png -------------------------------------------------------------------------------- /docs/account/images/profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/account/images/profile.png -------------------------------------------------------------------------------- /docs/account/managing-your-profile.md: -------------------------------------------------------------------------------- 1 | # Managing your profile 2 | 3 | To manage your profile information such as your name and avatar, click on your avatar on the top right-hand corner and select **Your account**. 4 | 5 | ![Managing your profile](images/profile.png) 6 | 7 | ## Changing your name or avatar 8 | 9 | - To change your avatar, sign up or log in at [Gravatar](https://en.gravatar.com/) using the same email address that you used to log into Codacy. The avatar that you define there will be automatically used as your avatar on Codacy. 10 | 11 | !!! note 12 | Organization avatars aren't editable at the moment. 13 | 14 | - To change your name, update the field **Name** and click the button **Update profile**. 15 | 16 | ## Deleting your account 17 | 18 | When you delete your account on Codacy: 19 | 20 | - Your profile information and all data related to your personal repositories are completely removed from Codacy 21 | - Codacy will [stop analyzing any repositories added to Codacy using your account](../faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md) 22 | 23 | This operation doesn't make any changes on your Git provider. 24 | 25 | To delete your account, click the button **Delete account** and confirm that you really want to proceed. 26 | 27 | !!! note 28 | If you're the last organization admin of any of your organizations, you must either add someone else as an owner or [delete those organizations](../organizations/what-are-organizations.md#deleting-an-organization) before you can delete your account. 29 | -------------------------------------------------------------------------------- /docs/account/user-session-management.md: -------------------------------------------------------------------------------- 1 | # User session management 2 | 3 | To reduce the risk of unauthorized access to your account, Codacy sets automatic expiration timeouts for every session. When a session expires, Codacy invalidates the session both on the client and server side, and creates a new session. 4 | 5 | 6 | ## Idle session timeout 7 | 8 | The **idle session timeout** on the Codacy app is **30 minutes**. In the absence of user activity during this period, such as typing or using the mouse, Codacy logs out the user and invalidates the session. 9 | 10 | ## Absolute session timeout 11 | 12 | The **absolute session timeout** on the Codacy app is **8 hours**. When an active session reaches this maximum period, Codacy logs out the user and invalidates the session. 13 | -------------------------------------------------------------------------------- /docs/assets/images/codacy-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/assets/images/codacy-logo.png -------------------------------------------------------------------------------- /docs/assets/images/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/assets/images/favicon.ico -------------------------------------------------------------------------------- /docs/assets/images/file-extensions-analyze.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/assets/images/file-extensions-analyze.png -------------------------------------------------------------------------------- /docs/assets/images/icon-checklist.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/assets/images/icon-checkmark.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/assets/images/icon-rss-feed.svg: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | RSS feed icon 7 | 8 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/assets/images/icon-user-management.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/assets/includes/admin-access-control-info.md: -------------------------------------------------------------------------------- 1 | !!! info "Organization admins can [manage access to this feature](../../organizations/roles-and-permissions-for-organizations.md#change-analysis-configuration)" 2 | -------------------------------------------------------------------------------- /docs/assets/includes/admin-access-info.md: -------------------------------------------------------------------------------- 1 | !!! info "Only organization admins can update this setting" 2 | -------------------------------------------------------------------------------- /docs/assets/includes/ai-info.md: -------------------------------------------------------------------------------- 1 | !!! note 2 | - This feature is compatible with most programming languages and requires no additional setup. 3 | - Comments are generated using the description of the static analysis issue, information about the tool that detected the issue, and a few lines of surrounding code to provide the AI with extra context and improve its accuracy. 4 | - This feature leverages the OpenAI API. No information is shared with other third parties or used to train AI models. Please refer to the [OpenAI API data usage policies](https://openai.com/policies/api-data-usage-policies) for more information. 5 | 6 | -------------------------------------------------------------------------------- /docs/assets/includes/api-example-pagination-important.md: -------------------------------------------------------------------------------- 1 | !!! important 2 | For the sake of simplicity, the example doesn't consider paginated results obtained from the Codacy API. [Learn how to use pagination](../../codacy-api/using-the-codacy-api.md#using-pagination) to ensure that you process all results returned by the API. 3 | -------------------------------------------------------------------------------- /docs/assets/includes/api-token-warning.md: -------------------------------------------------------------------------------- 1 | !!! warning 2 | **Never write API tokens to your configuration files** and keep your API tokens well protected, as they grant owner permissions to your projects on Codacy. 3 | 4 | It's a best practice to store API tokens as environment variables. Check the documentation of your CI/CD platform on how to do this. 5 | -------------------------------------------------------------------------------- /docs/assets/includes/client-side-tool-instructions.md: -------------------------------------------------------------------------------- 1 | 2 | 1. [Enable {{ page.meta.tool_name }}](../../repositories-configure/configuring-code-patterns.md) and configure the corresponding code patterns on your repository **Code patterns** page. 3 | 4 | 1. Enable **Run analysis on your build server** on your repository **Settings**, tab **General**, **Repository analysis on your server**. 5 | 6 | This setting enables Codacy to wait for the results of the local analysis before resuming the analysis of your commits. 7 | 8 | ![Run analysis on your build server](images/run-analysis-through-build-server.png) 9 | 10 | 1. Set up an API token to authenticate on Codacy: 11 | 12 | - **If you're setting up one repository**, [obtain a repository API token](../../codacy-api/api-tokens.md#repository-api-tokens) and set the following environment variable to specify your repository API token: 13 | 14 | ```bash 15 | export CODACY_PROJECT_TOKEN= 16 | ``` 17 | 18 | - **If you're setting up multiple repositories**, [obtain an account API Token](../../codacy-api/api-tokens.md#account-api-tokens) and set the following environment variable to specify the account API token: 19 | 20 | ```bash 21 | export CODACY_API_TOKEN= 22 | ``` 23 | 24 | {% include-markdown "./api-token-warning.md" %} 25 | 26 | 1. **If you're using Codacy Self-hosted** set the following environment variable to specify your Codacy instance URL: 27 | 28 | ```bash 29 | export CODACY_API_BASE_URL= 30 | ``` 31 | 32 | 33 | 34 | ## Advanced configuration 35 | 36 | See the available [Codacy Analysis CLI configuration flags](https://github.com/codacy/codacy-analysis-cli#configuration) to configure running {{ page.meta.tool_name }} in more advanced scenarios. 37 | 38 | -------------------------------------------------------------------------------- /docs/assets/includes/cloud.md: -------------------------------------------------------------------------------- 1 | !!! info "This page applies only to Codacy Cloud" 2 | -------------------------------------------------------------------------------- /docs/assets/includes/coverage-github-accept-permissions.md: -------------------------------------------------------------------------------- 1 | 2 | !!! info "GitHub only: this feature requires updated app permissions. If you haven't done so yet, please [review and accept the updated Codacy app permissions](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#reviewing-permissions) on GitHub" 3 | 4 | -------------------------------------------------------------------------------- /docs/assets/includes/coverage-ignore.md: -------------------------------------------------------------------------------- 1 | To exclude files from coverage analysis only, you must ignore them directly in the tool you're using to generate coverage reports and ensure that the reports you upload to Codacy don't include coverage information for those files. 2 | -------------------------------------------------------------------------------- /docs/assets/includes/dashboard-api-report-note.md: -------------------------------------------------------------------------------- 1 | !!! note 2 | You can use the Codacy API to generate reports or obtain information about the code quality of your repositories in a more flexible way. 3 | 4 | For more information see the list of [available API endpoints](https://api.codacy.com/api/api-docs#codacy-api-analysis) and the following examples: 5 | 6 | - [Obtaining current issues in repositories](../../codacy-api/examples/obtaining-current-issues-in-repositories.md) 7 | - [Obtaining code quality metrics for files](../../codacy-api/examples/obtaining-code-quality-metrics-for-files.md) 8 | -------------------------------------------------------------------------------- /docs/assets/includes/default-git-provider-settings-tip.md: -------------------------------------------------------------------------------- 1 | 2 | !!! tip 3 | Configure the [default Git provider integration settings](../../organizations/integrations/default-git-provider-integration-settings.md) that Codacy applies to new repositories to help ensure that all new repositories have the same settings. 4 | 5 | 6 | 7 | !!! tip 8 | You can [apply the default Git provider integration settings to all repositories](../../organizations/integrations/default-git-provider-integration-settings.md#apply-all) to ensure that your repositories all share the same settings. 9 | 10 | -------------------------------------------------------------------------------- /docs/assets/includes/nav-multistep-quickstart.md: -------------------------------------------------------------------------------- 1 | 39 | 40 | -------------------------------------------------------------------------------- /docs/assets/includes/paid.md: -------------------------------------------------------------------------------- 1 | 2 | !!! info "This feature is [only available on paid plans](https://www.codacy.com/pricing)" 3 | 4 | 5 | 6 | !!! info "Analyzing private repositories is [only available on paid plans](https://www.codacy.com/pricing)" 7 | 8 | 9 | 10 | !!! info "This is a [paid feature](https://www.codacy.com/pricing)" 11 | 12 | 13 | 14 | !!! info "This feature is [only available on Business plan](https://www.codacy.com/pricing)" 15 | 16 | -------------------------------------------------------------------------------- /docs/assets/includes/service-account-integration.md: -------------------------------------------------------------------------------- 1 | !!! tip 2 | Use a dedicated service account to integrate Codacy with your repositories. This prevents disruption of service if the user who originally enabled the integration loses access to the repositories, which may happen when a user leaves the team or the organization. 3 | 4 | For more information and instructions on how to set up a dedicated service account see [Why did Codacy stop commenting on pull requests?](../../faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md#outdated-permissions) 5 | -------------------------------------------------------------------------------- /docs/assets/includes/status-checks-important.md: -------------------------------------------------------------------------------- 1 | !!! important 2 | **To get a status for coverage** you must also: 3 | 4 | - [Add coverage to your repository](../../coverage-reporter/index.md) 5 | - Enable the rule **Diff coverage is under** or **Coverage variation is under** on the [pull request quality gate](../../repositories-configure/adjusting-quality-gates.md). 6 | -------------------------------------------------------------------------------- /docs/assets/includes/update-file-extensions-reanalyze.md: -------------------------------------------------------------------------------- 1 | 2 | The updated settings will be used on the next analysis, but you can click **reanalyze the latest commit of your branches now** on the notification that appears at the bottom of the page to trigger an analysis immediately. 3 | 4 | ![Analyze now](../images/file-extensions-analyze.png) 5 | 6 | -------------------------------------------------------------------------------- /docs/assets/stylesheets/version-select.css: -------------------------------------------------------------------------------- 1 | .version-select-container > span { 2 | color: #4c6083; 3 | font-size: 0.6rem; 4 | margin-right: 0.6rem; 5 | } 6 | 7 | .version-select-container .select-css { 8 | display: inline-block; 9 | cursor: pointer; 10 | height: 2rem; 11 | font-size: 0.7rem; 12 | box-sizing: border-box; 13 | color: #354b71; 14 | padding: 0.5rem; 15 | padding-right: 1.2rem; 16 | margin: 0; 17 | border: 0; 18 | border-radius: 0.25em; 19 | -moz-appearance: none; 20 | -webkit-appearance: none; 21 | appearance: none; 22 | background-color: #e5ecf5; 23 | background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='451.847' height='451.847'%3E%3Cpath fill='%23354B71' d='M225.923 354.706c-8.098 0-16.195-3.092-22.369-9.263L9.27 151.157c-12.359-12.359-12.359-32.397 0-44.751 12.354-12.354 32.388-12.354 44.748 0l171.905 171.915 171.906-171.909c12.359-12.354 32.391-12.354 44.744 0 12.365 12.354 12.365 32.392 0 44.751L248.292 345.449c-6.177 6.172-14.274 9.257-22.369 9.257z'/%3E%3C/svg%3E"); 24 | background-repeat: no-repeat, repeat; 25 | background-position: right 0.6em top 50%, 0 0; 26 | background-size: 0.55em auto, 100%; 27 | } 28 | 29 | .version-select-container .select-css::-ms-expand { 30 | display: none; 31 | } 32 | 33 | .version-select-container .select-css:hover { 34 | background-color: #c9d8ef; 35 | } 36 | 37 | .version-select-container .select-css option { 38 | font-weight: normal; 39 | } 40 | 41 | @media screen and (max-width: 719px) { 42 | .version-select-container .select-css { 43 | max-width: 38vw; 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /docs/codacy-api/images/codacy-api-tokens-account.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-api/images/codacy-api-tokens-account.png -------------------------------------------------------------------------------- /docs/codacy-api/images/codacy-api-tokens-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-api/images/codacy-api-tokens-repository.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/codacy-guardrails-limitations.md: -------------------------------------------------------------------------------- 1 | # Limitations 2 | 3 | ## Limitations with Windows 4 | 5 | Windows WSL (a feature that allows you to run a Linux environment directly on Windows, without the need for a virtual machine or dual-boot setup) is the only way you can use this feature for now, but we're still working to fully support Windows. -------------------------------------------------------------------------------- /docs/codacy-guardrails/codacy-guardrails-troubleshooting.md: -------------------------------------------------------------------------------- 1 | # Troubleshooting 2 | 3 | ## Node 4 | 5 | ### Claude Desktop 6 | 7 | When using NVM with Claude Desktop, NPX may not work. You should first install the MCP Server globally, and then use Node directly: 8 | 9 | ```bash 10 | npm install -g @codacy/codacy-mcp 11 | ``` 12 | 13 | ```json 14 | { 15 | "mcpServers": { 16 | "codacy": { 17 | "command": "/Users/yourusername/.nvm/versions/node/vXX.X.X/bin/node", 18 | "args": ["/path-to/codacy-mcp/dist/index.js"], 19 | "env": { 20 | "CODACY_ACCOUNT_TOKEN": "", 21 | "CODACY_CLI_VERSION": "" 22 | } 23 | } 24 | } 25 | } 26 | ``` -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/add-codacy-mcp-server.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/add-codacy-mcp-server.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/analysis-webserver-implementation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/analysis-webserver-implementation.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/codacy-extension-activate-cli.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/codacy-extension-activate-cli.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/codacy-extension-add-api-token-workspace.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/codacy-extension-add-api-token-workspace.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/codacy-extension-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/codacy-extension-settings.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/code-patterns-config-file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/code-patterns-config-file.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/code-patterns-configure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/code-patterns-configure.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/code-patterns-cs-customize-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/code-patterns-cs-customize-modal.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/code-patterns-cs-customize.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/code-patterns-cs-customize.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/code-patterns-toggle-tools.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/code-patterns-toggle-tools.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/code-patterns.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/code-patterns.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/copilot_agent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/copilot_agent.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/create-webserver-java.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/create-webserver-java.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/install-codacy-extension.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/install-codacy-extension.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/list-security-issues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/list-security-issues.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/mcp-server-enabled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/mcp-server-enabled.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/no-issues-webserver.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/no-issues-webserver.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/prompt-list-security-issues-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/prompt-list-security-issues-repository.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/response-webserver.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/response-webserver.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/run-mcp-tool-list-security-issues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/run-mcp-tool-list-security-issues.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/settings-json-vscode.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/settings-json-vscode.png -------------------------------------------------------------------------------- /docs/codacy-guardrails/images/start-mcp-server-vscode.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/codacy-guardrails/images/start-mcp-server-vscode.png -------------------------------------------------------------------------------- /docs/coverage-reporter/images/coverage-codacy-ui-logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/coverage-reporter/images/coverage-codacy-ui-logs.png -------------------------------------------------------------------------------- /docs/coverage-reporter/images/coverage-codacy-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/coverage-reporter/images/coverage-codacy-ui.png -------------------------------------------------------------------------------- /docs/coverage-reporter/images/coverage-pr-commits.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/coverage-reporter/images/coverage-pr-commits.png -------------------------------------------------------------------------------- /docs/coverage-reporter/images/coverage-test-integration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/coverage-reporter/images/coverage-test-integration.png -------------------------------------------------------------------------------- /docs/coverage-reporter/images/coverage-validate.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/coverage-reporter/images/coverage-validate.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Access enterprises.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Access enterprises.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Access managmeent access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Access managmeent access.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Codacy-Access-Management-revoke-approval.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Codacy-Access-Management-revoke-approval.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Codacy-Access-Management-revoke.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Codacy-Access-Management-revoke.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Codacy-Access-Management.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Codacy-Access-Management.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Codacy-Enterprise-Organizations.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Codacy-Enterprise-Organizations.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Codacy-Enterprise-Seats.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Codacy-Enterprise-Seats.png -------------------------------------------------------------------------------- /docs/enterprise-cloud/images/Codacy-Enterprises.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/enterprise-cloud/images/Codacy-Enterprises.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/can-i-bypass-codacy-status-check.md: -------------------------------------------------------------------------------- 1 | # Can I bypass Codacy status check? 2 | 3 | To protect your code from unwelcome changes, you can [configure your Git workflow to block merging pull requests](../../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests) if they don't pass the Codacy status check. 4 | 5 | However, on **very specific and exceptional situations** where your pull request merging is blocked due to an unexpected issue not related to the quality of your code, Codacy allows **repository admins** to bypass the Codacy status check for that pull request. 6 | 7 | To bypass Codacy status check for a pull request, a repository admin must click **Bypass status checks** on the [pull request status area](../../repositories/pull-requests.md#status) of the pull request detail screen. 8 | 9 | ![Bypass status check for pull request](images/bypass-status-check.png) 10 | -------------------------------------------------------------------------------- /docs/faq/code-analysis/does-codacy-check-for-dependencies.md: -------------------------------------------------------------------------------- 1 | # Does Codacy check for dependencies? 2 | 3 | Yes, Codacy scans the manifest files of your repositories and displays any vulnerable dependencies as Codacy issues. 4 | 5 | For a list of supported languages and manifest files scanned by the Codacy dependency vulnerability scanning tools, see [Supported languages and tools](../../getting-started/supported-languages-and-tools.md). 6 | -------------------------------------------------------------------------------- /docs/faq/code-analysis/how-long-does-it-take-for-my-repository-to-be-analyzed.md: -------------------------------------------------------------------------------- 1 | # How long does it take for my repository to be analyzed? 2 | 3 | Codacy usually takes under 5 minutes to analyze your repository. It may however take longer, depending on a number of factors: 4 | 5 | - **Whether it's the initial analysis of your repository** 6 | 7 | The initial analysis examines all files in the repository, while each subsequent commit triggers an analysis only on files changed in that commit. 8 | 9 | - **Whether tool configurations have been updated** 10 | 11 | Updates to tool configurations trigger a reanalysis of all files in the repository on the next commit and may impact analysis duration. 12 | 13 | - **The size of your repository** 14 | 15 | To speed up the analysis, [ignore any files and directories](../../repositories-configure/ignoring-files.md) that aren't relevant to your project, such as generated code or any third-party libraries included in your repositories. 16 | 17 | - **The time it takes your Git provider to trigger the analysis** 18 | 19 | Codacy relies on post-commit hooks sent by your Git provider to trigger the analysis after each push to the repository, so if your analysis is taking a lot of time to start [check that the Post-Commit Hook integration for your repository is enabled](../../repositories-configure/integrations/post-commit-hooks.md). 20 | 21 | - **The priority of your analysis request and the current load on Codacy's servers** 22 | 23 | Open-source projects have lower priority in the Codacy analysis queues. 24 | 25 | - **Whether Codacy or your Git provider is currently experiencing issues or outages** 26 | 27 | Check the [Codacy status page](https://status.codacy.com/) and the status page of your Git provider ([GitHub](https://www.githubstatus.com/), [GitLab](https://status.gitlab.com/), [Bitbucket](https://bitbucket.status.atlassian.com/)) to see if there is any ongoing incident that could delay the analysis. 28 | -------------------------------------------------------------------------------- /docs/faq/code-analysis/how-to-skip-an-analysis.md: -------------------------------------------------------------------------------- 1 | # How to skip an analysis? 2 | 3 | By default, Codacy automatically analyzes a repository whenever you push changes. However, you can override this behavior by adding one of the "skip" tags - `[ci skip]`, `[skip ci]`, `[codacy skip]` or `[skip codacy]` - anywhere in the subject or body of the commit message. For example: 4 | 5 | ```bash 6 | git commit -a -m "Add eslint-plugin-chai-expect version 1.1.1 [ci skip]" 7 | ``` 8 | 9 | If you later decide to analyze a skipped commit, you can override any skip tags by [reanalyzing the commit](../repositories/how-do-i-reanalyze-my-repository.md). 10 | 11 | !!! note 12 | This feature isn't supported for pull requests. 13 | -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/bypass-status-check.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/bypass-status-check.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/coverage-example-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/coverage-example-1.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/coverage-example-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/coverage-example-2.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/grade_a.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/grade_a.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/grade_b.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/grade_b.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/grade_c.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/grade_c.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/grade_d.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/grade_d.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/grade_e.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/grade_e.png -------------------------------------------------------------------------------- /docs/faq/code-analysis/images/grade_f.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/code-analysis/images/grade_f.png -------------------------------------------------------------------------------- /docs/faq/general/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/general/.DS_Store -------------------------------------------------------------------------------- /docs/faq/general/does-codacy-keep-audit-logs.md: -------------------------------------------------------------------------------- 1 | # Does Codacy keep audit logs for my organization? 2 | 3 | On [Business plan](https://www.codacy.com/pricing), Codacy logs significant organization events that can be retrieved for audit reporting. 4 | 5 | See [Audit logs for organizations](../../organizations/audit-logs-for-organizations.md) for the complete list of events that Codacy logs, and how to obtain audit log data. 6 | -------------------------------------------------------------------------------- /docs/faq/general/how-can-i-change-or-cancel-my-plan.md: -------------------------------------------------------------------------------- 1 | # How can I change or cancel my plan? 2 | 3 | You can change or cancel [your Codacy plan](https://www.codacy.com/pricing) at any time. If you choose to cancel your annual subscription before the conclusion of the 12 months, your account will continue to work for the remainder of the annual billing period. 4 | 5 | Codacy values feedback and we thank you in advance for letting us know the primary reason behind your decision to leave, whether budgetary constraints or missing deal-breaker functionality. 6 | 7 | ## If you're using Codacy Cloud 8 | 9 | If you're using Codacy Cloud see [how to change the plan and billing of your Codacy organization](../../organizations/changing-your-plan-and-billing.md). 10 | 11 | Alternatively, [delete your organization](../../organizations/what-are-organizations.md#deleting-an-organization) to remove all its repositories from Codacy and cancel your existing plan. 12 | 13 | {% 14 | include-markdown "../../organizations/changing-your-plan-and-billing.md" 15 | start="" 16 | end="" 17 | %} 18 | 19 | ## If you're using Codacy Self-hosted 20 | 21 | To help you understand how you're consuming your licensed Codacy seats, use [codacy-usage-report](https://github.com/codacy/codacy-usage-report) to obtain details about the activity of the users in your Codacy Self-hosted instance. 22 | 23 | If you decide to cancel your plan, please contact and we'll swiftly process the cancellation. 24 | 25 | ## See also 26 | 27 | - [Changing your plan and billing](../../organizations/changing-your-plan-and-billing.md) 28 | -------------------------------------------------------------------------------- /docs/faq/general/how-does-codacy-keep-my-data-secure.md: -------------------------------------------------------------------------------- 1 | # How does Codacy keep my data secure? 2 | 3 | Keeping our customers' data protected at all times is our highest priority. This [security overview](https://security.codacy.com/) provides a high-level overview of the security practices put in place to achieve that objective. 4 | 5 | Have questions or feedback? Feel free to reach out to us at . 6 | -------------------------------------------------------------------------------- /docs/faq/general/how-does-codacy-protect-my-privacy.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: At Codacy, keeping your personal data safe has always been a top priority and we look at GDPR as another opportunity for us to strengthen this commitment to you. 3 | --- 4 | 5 | # How does Codacy protect my privacy? 6 | 7 | In May 2018 the new "General Data Protection Regulation" ([GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation)) came into effect. This regulation contains the most significant changes to European data privacy legislation in the last 20 years and gives you more control over your personal data and greater transparency on how it's used. 8 | 9 | At Codacy, keeping your personal data safe has always been a top priority and we took GDPR as another opportunity for us to strengthen this commitment to you. We've changed our data processing policies, operations, activities, and documentation as a response to GDPR and have updated our [Privacy Policy](https://www.codacy.com/privacy) to incorporate said changes and specifically reflect the new regulation. 10 | 11 | Below are some highlights of the updated policy: 12 | 13 | - Transparency: We've reworded our privacy policy for better navigation and to make it easier to read. Our policy outlines the type of personal data we collect, how we collect and process the data, and for what purposes. It also explains how we store, transfer, and share personal data, and our data retention practices 14 | - Control: Our policy now further explains the control you have over information about you and your online activities. At any time, you can request information, correction, deletion, or changes to your personal data or/and make changes yourself 15 | - GDPR: We've included additional language to discuss rights for users located in the European Union (EU) 16 | 17 | If you have any questions on this, please email us at or reach out through our live chat option. 18 | -------------------------------------------------------------------------------- /docs/faq/general/how-does-codacy-support-github-enterprise.md: -------------------------------------------------------------------------------- 1 | # How does Codacy support GitHub Enterprise Cloud? 2 | 3 | When you use GitHub Enterprise to sign up or log into Codacy, the GitHub Enterprise organizations, that you belong to, will be available to be added as Organizations on Codacy. 4 | 5 | After connecting with your Enterprise account Codacy displays the list of all organizations that you have access to in that Enterprise, and you can add to start analysing its repositories or join it. 6 | 7 | 8 | ## Limitations 9 | 10 | Currently, the integration between Codacy and GitHub Enterprise has the following limitations: 11 | 12 | - **Repositories with visibility Internal** will, in Codacy, have the same behavior as Private visibility. Although you see the repository in the provider, if you are not part of the repository in the provider, you will not be able to see it in Codacy. 13 | - **Same email connected to multiple GitHub accounts.** Codacy will not allow you to connect your enterprise account if that email is already associated with a different GitHub account. You can manage your [associated emails in the provider GitHub](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). 14 | 15 | 16 | ## See also 17 | 18 | - [How to manage your GitHub Enterprise organization](../../enterprise-cloud/github-enterprise-cloud.md) -------------------------------------------------------------------------------- /docs/faq/general/how-does-codacy-support-gitlab-enterprise.md: -------------------------------------------------------------------------------- 1 | # How does Codacy support GitLab Enterprise? 2 | 3 | When you use GitLab Enterprise to sign up or log into Codacy, the GitLab Groups that you belong to will be available to be added as Organizations on Codacy. 4 | 5 | After adding a Group: 6 | 7 | - Codacy displays the list of all repositories that you own in that Group and Subgroups so that you can add them to Codacy as repositories to be analyzed 8 | - The members of the Group will be able to [join or request to join Codacy](../../organizations/managing-people.md#joining) 9 | 10 | If you have repositories that don't belong to any Group, you can still [add those on Codacy by choosing your "personal" organization](../../getting-started/codacy-quickstart.md#choosing-organization). 11 | 12 | ## Limitations 13 | 14 | Currently, the integration between Codacy and GitLab Enterprise has the following limitations: 15 | 16 | - **Repositories that are moved between Groups are not automatically transferred between Organizations on Codacy.** You must manually delete these repositories from their source Organization and add them to their new Organization. 17 | - **It is not possible to add repositories with the same name to the Codacy organization.** Repositories having the same name but belonging to different GitLab Subgroups would collide if they were added to the same Codacy organization. 18 | - **Codacy doesn't analyze pull requests submitted from forked repositories.** 19 | - **[Share projects with other groups](https://docs.gitlab.com/ee/user/project/members/share_project_with_groups.html) isn't fully supported on Codacy.** Users from the "other groups" can join the Organization that owns the project on the Codacy side, and Codacy will analyze the commits from those users. However, those users **won't** be able to access the project on the Codacy UI. 20 | 21 | ## See also 22 | 23 | - [What are organizations](../../organizations/what-are-organizations.md) 24 | -------------------------------------------------------------------------------- /docs/faq/repositories/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/repositories/.DS_Store -------------------------------------------------------------------------------- /docs/faq/repositories/i-moved-my-repository-on-the-git-provider.md: -------------------------------------------------------------------------------- 1 | # I moved my repository on the Git provider 2 | 3 | Currently, Codacy doesn't automatically detect moves of repositories between two organizations. 4 | 5 | To ensure that Codacy continues to analyze a repository that was moved to another organization on your Git provider: 6 | 7 | 1. Delete the repository from the original organization on Codacy, taking note of the settings for this repository 8 | 1. Add the repository to the new organization on Codacy and reconfigure the repository with the same settings as the original one 9 | 10 | If you can't find your repository in the original Codacy organization or if you need more help with this process, please contact us at . 11 | -------------------------------------------------------------------------------- /docs/faq/repositories/i-renamed-my-repository-on-the-git-provider.md: -------------------------------------------------------------------------------- 1 | # I renamed my repository on the Git provider 2 | 3 | If you changed the name or URL of your repository on your Git provider, you can update the name and URL of the repository on Codacy to point to the new location. This ensures that you won't lose historical data about your repository on Codacy. 4 | 5 | To rename your repository on Codacy, open the page **Settings** and click the button **Update repository**. 6 | 7 | ![Renaming your repository](images/repository-rename.png) 8 | -------------------------------------------------------------------------------- /docs/faq/repositories/images/codacy-badge-grade-gray.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/repositories/images/codacy-badge-grade-gray.png -------------------------------------------------------------------------------- /docs/faq/repositories/images/reanalyze-repository-commit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/repositories/images/reanalyze-repository-commit.png -------------------------------------------------------------------------------- /docs/faq/repositories/images/reanalyze-repository-commits-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/repositories/images/reanalyze-repository-commits-list.png -------------------------------------------------------------------------------- /docs/faq/repositories/images/reanalyze-repository-pr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/repositories/images/reanalyze-repository-pr.png -------------------------------------------------------------------------------- /docs/faq/repositories/images/reanalyze-repository-prs-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/repositories/images/reanalyze-repository-prs-list.png -------------------------------------------------------------------------------- /docs/faq/repositories/images/repository-rename.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/repositories/images/repository-rename.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/duplication-commits.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/duplication-commits.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/duplication-files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/duplication-files.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/duplication-metrics-reset.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/duplication-metrics-reset.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/error-line-endings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/error-line-endings.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/git-provider-integration-remove.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/git-provider-integration-remove.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/not-a-member-of-the-organization-account.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/not-a-member-of-the-organization-account.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/not-a-member-of-the-organization-commit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/not-a-member-of-the-organization-commit.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/organization-refresh-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/organization-refresh-list.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/images/we-no-longer-have-access-to-this-repository-new-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/faq/troubleshooting/images/we-no-longer-have-access-to-this-repository-new-key.png -------------------------------------------------------------------------------- /docs/faq/troubleshooting/not-a-member-of-the-organization.md: -------------------------------------------------------------------------------- 1 | # Not a member of the organization 2 | 3 | {% 4 | include-markdown "../../assets/includes/cloud.md" 5 | %} 6 | 7 | When you see the message **Not a member of the organization** it means that Codacy Cloud can't analyze a commit because the associated email address doesn't belong to any [member or committer of your Codacy organization](../../organizations/managing-people.md). 8 | 9 | You can check which email address is associated with a commit by hovering the cursor on the name of the committer on the page for the commit: 10 | 11 | ![Checking the email address for a commit](images/not-a-member-of-the-organization-commit.png) 12 | 13 | To verify which email addresses are associated with the Codacy Cloud account, the user must click on their avatar on the top right-hand corner, select **Your account**, and open the page **Emails**: 14 | 15 | ![Email addresses associated with a user account](images/not-a-member-of-the-organization-account.png) 16 | 17 | There may be different reasons for this issue to happen: 18 | 19 | - **The user making the commit hasn't signed in to Codacy Cloud and joined the organization yet** 20 | 21 | The user must [join the organization](../../organizations/managing-people.md#joining) or, if you're the organization admin, you can [add the user](../../organizations/managing-people.md#adding-people) instead. 22 | 23 | - **The commit email address isn't associated with the account of a Codacy Cloud user** 24 | 25 | Make sure the user [updates the email addresses associated with their Codacy account](../../account/emails.md#updating) to include the missing commit email address. 26 | 27 | - **Git isn't configured with the correct email address** 28 | 29 | Make sure the user [sets the Git email address](../../account/emails.md#git-config) correctly. 30 | -------------------------------------------------------------------------------- /docs/faq/troubleshooting/why-cant-i-see-my-organization.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: Try these steps if you don't see your organization when adding your organization on Codacy. 3 | --- 4 | 5 | # Why can't I see my organization? 6 | 7 | If you can't [add your organization to Codacy](../../organizations/what-are-organizations.md#adding-an-organization) because it doesn't appear on the Organizations page, please try re-adding your Git provider by clicking **Add provider** on the Organizations page: 8 | 9 | ![Refreshing the list of organizations](images/organization-refresh-list.png) 10 | 11 | If you still can't see your organization on Codacy, follow the steps below to check if the issue is solved: 12 | 13 | 1. Re-add your Git provider by clicking **Add provider** on the Organizations page. 14 | 15 | 1. Make sure that you have access to the organization on the Git provider using the account that you used to log in on Codacy. 16 | 17 | 1. **If you're using GitHub** [install and authorize Codacy on your organization](https://github.com/apps/codacy-production/installations/new). 18 | 19 | 1. [Revoke Codacy's OAuth integration](../../getting-started/which-permissions-does-codacy-need-from-my-account.md#revoking-access-to-integrations) with your Git provider and log in again to Codacy. 20 | 21 | ![Revoking Codacy's OAuth integration](../../getting-started/images/revoke-integration.png) 22 | 23 | If these steps don't solve the issue, please contact us at . 24 | -------------------------------------------------------------------------------- /docs/faq/troubleshooting/why-isnt-my-public-repository-being-analyzed.md: -------------------------------------------------------------------------------- 1 | # Why isn't my public repository being analyzed? 2 | 3 | Codacy only analyzes open source repositories if the admin of the repository is a committer to that repository. 4 | -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-badge-example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-badge-example.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-badge-gray.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-badge-gray.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-badge.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-badge.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-intellij-plugin-main-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-intellij-plugin-main-view.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-intellij-plugin-problems-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-intellij-plugin-problems-tab.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-intellij-plugin-sign-in.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-intellij-plugin-sign-in.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-analyzed-branch-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-analyzed-branch-tab.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-important-issues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-important-issues.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-inline-coverage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-inline-coverage.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-main-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-main-view.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-problems-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-problems-tab.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-pull-requests-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-pull-requests-tab.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-sign-in.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-sign-in.png -------------------------------------------------------------------------------- /docs/getting-started/images/codacy-vscode-extension-status-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/codacy-vscode-extension-status-tab.png -------------------------------------------------------------------------------- /docs/getting-started/images/revoke-integration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/getting-started/images/revoke-integration.png -------------------------------------------------------------------------------- /docs/organizations/images/Segments-no-sync.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/Segments-no-sync.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-apply.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-apply.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-configure-tools.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-configure-tools.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-create.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-create.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-delete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-delete.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-edit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-edit.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-presets.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-presets.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-recommended-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-recommended-icon.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-rename.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-rename.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-select-languages.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-select-languages.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-set-default.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-set-default.png -------------------------------------------------------------------------------- /docs/organizations/images/coding-standard-strategy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/coding-standard-strategy.png -------------------------------------------------------------------------------- /docs/organizations/images/gate-policy-apply.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/gate-policy-apply.png -------------------------------------------------------------------------------- /docs/organizations/images/gate-policy-codacy-default.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/gate-policy-codacy-default.png -------------------------------------------------------------------------------- /docs/organizations/images/gate-policy-create.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/gate-policy-create.png -------------------------------------------------------------------------------- /docs/organizations/images/gate-policy-delete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/gate-policy-delete.png -------------------------------------------------------------------------------- /docs/organizations/images/gate-policy-edit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/gate-policy-edit.png -------------------------------------------------------------------------------- /docs/organizations/images/gate-policy-select-values.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/gate-policy-select-values.png -------------------------------------------------------------------------------- /docs/organizations/images/gate-policy-set-default.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/gate-policy-set-default.png -------------------------------------------------------------------------------- /docs/organizations/images/issues-activity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/issues-activity.png -------------------------------------------------------------------------------- /docs/organizations/images/open-issues-by-category.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/open-issues-by-category.png -------------------------------------------------------------------------------- /docs/organizations/images/open-issues-by-severity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/open-issues-by-severity.png -------------------------------------------------------------------------------- /docs/organizations/images/open-issues-dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/open-issues-dashboard.png -------------------------------------------------------------------------------- /docs/organizations/images/open-issues-evolution-by-category.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/open-issues-evolution-by-category.png -------------------------------------------------------------------------------- /docs/organizations/images/open-issues-evolution-by-severity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/open-issues-evolution-by-severity.png -------------------------------------------------------------------------------- /docs/organizations/images/open-issues-ranking.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/open-issues-ranking.png -------------------------------------------------------------------------------- /docs/organizations/images/open-issues-tab-options.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/open-issues-tab-options.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-add-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-add-menu.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-add.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-add.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-delete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-delete.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-join.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-join.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-manage-repos-custom-properties-sync.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-manage-repos-custom-properties-sync.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-manage-repos-custom-properties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-manage-repos-custom-properties.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-overview-overall-quality-grouped.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-overview-overall-quality-grouped.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-overview-overall-quality.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-overview-overall-quality.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-overview-repositories-last-updated.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-overview-repositories-last-updated.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-people-add-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-people-add-button.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-people-add-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-people-add-modal.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-people-remove.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-people-remove.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-people.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-people.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-plan-billing-people-accept.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-plan-billing-people-accept.png -------------------------------------------------------------------------------- /docs/organizations/images/organization-plan-billing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/organization-plan-billing.png -------------------------------------------------------------------------------- /docs/organizations/images/repositories-add.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/repositories-add.png -------------------------------------------------------------------------------- /docs/organizations/images/repositories-analyzing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/repositories-analyzing.png -------------------------------------------------------------------------------- /docs/organizations/images/repositories-follow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/repositories-follow.png -------------------------------------------------------------------------------- /docs/organizations/images/repositories.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/repositories.png -------------------------------------------------------------------------------- /docs/organizations/images/roles-permissions-organization-manager-assign.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/roles-permissions-organization-manager-assign.png -------------------------------------------------------------------------------- /docs/organizations/images/roles-permissions-repo-management.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/roles-permissions-repo-management.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-app-scanning.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-app-scanning.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-dependencies-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-dependencies-list.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-dependencies-single.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-dependencies-single.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-finding-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-finding-details.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-finding-ignore.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-finding-ignore.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-finding-unignore-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-finding-unignore-list.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-finding-unignore.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-finding-unignore.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-findings-segments.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-findings-segments.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-findings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-findings.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-overview-distribution.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-overview-distribution.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-overview-history-activity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-overview-history-activity.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-overview-history-open.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-overview-history-open.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-overview-open.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-overview-open.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-overview-top-categories.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-overview-top-categories.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-overview-top-risk.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-overview-top-risk.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-overview.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-segments-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-segments-overview.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-slas-configure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-slas-configure.png -------------------------------------------------------------------------------- /docs/organizations/images/security-risk-management-slas-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/security-risk-management-slas-modal.png -------------------------------------------------------------------------------- /docs/organizations/images/segments-after-sync.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/images/segments-after-sync.png -------------------------------------------------------------------------------- /docs/organizations/integrations/default-git-provider-integration-settings.md: -------------------------------------------------------------------------------- 1 | # Default Git provider integration settings 2 | 3 | You can configure the default settings that Codacy uses to integrate with your Git provider when you add a new repository to Codacy. This enables you to apply the same settings across your organization repositories. 4 | 5 | To configure these default settings, open your organization **Integrations** page and select your Git provider. 6 | 7 | ![Default Git provider integration settings](images/default-git-provider-settings.png) 8 | 9 | The organization-level Git provider integration settings define the defaults that Codacy applies to new repositories. You can then customize the settings for each individual repository, which depend on your Git provider, [GitHub](../../repositories-configure/integrations/github-integration.md), [GitLab](../../repositories-configure/integrations/gitlab-integration.md) or [Bitbucket](../../repositories-configure/integrations/bitbucket-integration.md). 10 | 11 | ## Applying default settings to all repositories {: id="apply-all"} 12 | 13 | To ensure that all your repositories are configured with the default Git provider integration settings defined for your organization, click the button **Apply default to all repositories**. 14 | 15 | ![Apply default settings to all repositories](images/default-git-provider-settings-apply-all.png) 16 | 17 | ## See also 18 | 19 | - [Integrating Codacy with your Git workflow](../../getting-started/integrating-codacy-with-your-git-workflow.md) 20 | -------------------------------------------------------------------------------- /docs/organizations/integrations/images/default-git-provider-settings-apply-all.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/integrations/images/default-git-provider-settings-apply-all.png -------------------------------------------------------------------------------- /docs/organizations/integrations/images/default-git-provider-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/integrations/images/default-git-provider-settings.png -------------------------------------------------------------------------------- /docs/organizations/integrations/images/jira-integration-srm-install.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/integrations/images/jira-integration-srm-install.png -------------------------------------------------------------------------------- /docs/organizations/integrations/images/slack-integration-install.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/integrations/images/slack-integration-install.png -------------------------------------------------------------------------------- /docs/organizations/integrations/images/slack-integration-message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/organizations/integrations/images/slack-integration-message.png -------------------------------------------------------------------------------- /docs/organizations/integrations/slack-integration.md: -------------------------------------------------------------------------------- 1 | # Organization Slack integration for Security issues 2 | 3 | The organization Slack integration for Security issues sends notifications to a Slack channel of your choice whenever Codacy detects new critical Security issues in the default branch of any repository in your organization. 4 | 5 | ## Installing the Slack integration 6 | 7 | To install the Slack integration: 8 | 9 | 1. **On Slack**: 10 | 1. Access the [Incoming WebHooks](https://slack.com/apps/new/A0F7XDUAZ-incoming-webhooks) page on the App Directory of your Slack account. 11 | 12 | 1. Select the channel where you want to receive notifications and click **Add Incoming WebHooks Integration**. 13 | 14 | 1. Copy the Incoming WebHook URL (it starts with `https://hooks.slack.com/services/`). 15 | 16 | 1. **On Codacy**: 17 | 18 | 1. Open your organization **Integrations**, page **Slack**. 19 | 20 | 1. Paste the Incoming WebHook URL in the field and click **Install Slack**. 21 | 22 | ![Slack integration installation](images/slack-integration-install.png) 23 | 24 | Once the Slack integration is installed, Codacy sends a confirmation message to the Slack channel you configured when creating the Incoming WebHook. From there on, Codacy notifies you on the same channel whenever a new critical Security issue is detected in the default branch of any repository in your organization. 25 | 26 | ![Slack integration message](images/slack-integration-message.png) 27 | 28 | ## Uninstalling the Slack integration 29 | 30 | To uninstall the Slack integration, open your organization **Integrations**, page **Slack**, then click **Uninstall Slack** and confirm. 31 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2018-07-23.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud July 23, 2018. 5 | --- 6 | 7 | # Cloud July 23, 2018 8 | 9 | ## New release 10 | 11 | - Added ability to copy project badge from the project dashboard 12 | 13 | ## Improvements 14 | 15 | Added new documentation on: 16 | 17 | - SSH Keys 18 | 19 | ## Bug fixes 20 | 21 | - Fixed Pylint pattern `Enforce naming conventions` that had stopped providing results 22 | - You can import certain modules in your ESLint configuration files 23 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2018-10-19.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud October 19, 2018. 5 | --- 6 | 7 | # Cloud October 19, 2018 8 | 9 | ## Product enhancements 10 | 11 | - Improved the coverage UI on the project dashboard: 12 | - The value in the graph for coverage is now also displayed below, in the coverage issues breakdown. 13 | - Added color scheme dependent on project quality settings: from red to green depending on your settings, and blue if your coverage is set to be ignored. 14 | - Added tooltip explanations for issues related to coverage. 15 | 16 | - We updated the following tools: 17 | - Scalameta now supports Scala 2.12 18 | - Credo version [0.10.2](https://github.com/rrrene/credo/blob/master/CHANGELOG.md#0102) 19 | - Checkstyle version [8.13](http://checkstyle.sourceforge.net/releasenotes.html#Release_8.13) 20 | - Bandit version [1.5.1](https://github.com/PyCQA/bandit/releases/tag/1.5.1) 21 | - PHP_CodeSniffer version [3.1](https://pear.php.net/package/PHP_CodeSniffer/download/3.1.0) 22 | 23 | ## Bugs 24 | 25 | - Fixed a bug on that highlighted the wrong section on the sidebar when scrolling 26 | down. 27 | - Fixed Pylint broken build. 28 | - Fixed a bug preventing new commits from showing on a branch. 29 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2018-11-02.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud November 2, 2018. 5 | --- 6 | 7 | # Cloud November 2, 2018 8 | 9 | ## Product enhancements 10 | 11 | - Improved Issues Breakdown UI on the dashboard: 12 | - Removed project’s number of lines of code making it easier to 13 | understand the issue split percentage. 14 | 15 | ## Bug fixes 16 | 17 | - Fixed a bug in which Pylint wasn’t generating issues. 18 | - Fixed a bug in which private projects returned a blank page for 19 | unauthorized users instead of a 404 error page. 20 | 21 | ## Tool updates 22 | 23 | - Updated RuboCop to version [v0.59.2](https://github.com/rubocop/rubocop/blob/master/relnotes/v0.59.2.md) 24 | - Updated ESLint to version [v5.7.0](https://eslint.org/blog/2018/10/eslint-v5.7.0-released) 25 | - Added support to [TSLint 5](https://www.npmjs.com/package/tslint/v/5.11.0) 26 | - Previous versions are no longer supported. 27 | 28 | ## New tools 29 | 30 | - Added SwiftLint to Codacy. 31 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2018-11-16.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud November 16, 2018. 5 | --- 6 | 7 | # Cloud November 16, 2018 8 | 9 | ## Product enhancements 10 | 11 | We now support PowerShell language using [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer). 12 | 13 | Created default patterns for Flawfinder. 14 | 15 | - Now when you add a project to Codacy, Flawfinder will run by default. 16 | 17 | We updated the following tools to newer versions: 18 | 19 | - RuboCop to [v0.60.0](https://github.com/rubocop/rubocop/blob/master/relnotes/v0.60.0.md) 20 | - ESLint to [v5.8.0](https://eslint.org/blog/2018/10/eslint-v5.8.0-released) 21 | - ESLint plugin airbnb-eslint-config to [v17.1.0](https://www.npmjs.com/package/eslint-config-airbnb/v/17.1.0) 22 | - ESLint plugin babel-eslint to [v10.0.1](https://www.npmjs.com/package/babel-eslint/v/10.0.1) 23 | - ESLint plugin-jsx-a11y to [v.6.1.2](https://www.npmjs.com/package/eslint-plugin-jsx-a11y/v/6.1.2) 24 | 25 | - And added the following new plugins for ESLint: 26 | - eslint-config-standard-react 27 | - .prettierrc.js extension 28 | - prodigy eslint profile 29 | 30 | ## Bug fixes 31 | 32 | - Fixed a bug in which the GitHub login button was trying to use Bitbucket credentials and vice versa. 33 | - Fixed a bug that was adding projects from a deleted organization to an organization admin. Now all projects associated with a deleted organization will also be permanently deleted 34 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-01-02.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud January 2, 2019. 5 | --- 6 | 7 | # Cloud January 2, 2019 8 | 9 | ## Product enhancements 10 | 11 | - We updated the following tools to newer versions: 12 | - eslint-plugin-vue to version [5.0.0](https://www.npmjs.com/package/eslint-plugin-vue/v/5.0.0) 13 | - eslint-config-react-app to version [3.0.5](https://www.npmjs.com/package/eslint-config-react-app/v/3.0.5-next.c662dfb0) 14 | - eslint-plugin-react to version [7.11.1](https://www.npmjs.com/package/eslint-plugin-react/v/7.11.1) 15 | - And added the below new plugins for 16 | - eslint-plugin-ember-suave [v.1.0.0](https://www.npmjs.com/package/eslint-plugin-ember-suave/v/1.0.0) 17 | - tslint-angular [v.1.1.2](https://www.npmjs.com/package/tslint-angular/v/1.1.2) 18 | - Improved the UI message when a file is ignored to clarify that the changes will only be applied in the next analysis 19 | 20 | ## Bug fixes 21 | 22 | - Fixed a bug where it wasn't possible to select certain projects in the Team Dashboard 23 | - Fixed a bug where an issue showed the error message repeated in the block of code, instead of the source code line 24 | - Fixed a bug that was showing nonexistent Stylelint patterns in the UI 25 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-02-18-bitbucket-changes.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Bitbucket changes February 18, 2019 7 | 8 | We're making some changes on February 18, 2019 **that will cause all existing integrations with Bitbucket to stop working**. 9 | 10 | ## What exactly are we doing? 11 | 12 | We're reducing the permissions requested when authenticating with Bitbucket. 13 | 14 | While we currently ask for all permissions, after this we will no longer require: 15 | 16 | - Write access for Teams 17 | - Write access for Projects 18 | - Delete access for Repositories 19 | - Full access to Wikis, Snippets, and Pipelines 20 | 21 | ## Why? 22 | 23 | Previously, we were using OAuth 1, which forced us to request all permissions. This level of permissions requested to integrate with Bitbucket has been flagged as a concern by several of our users. We've now migrated to OAuth 2, which allows us to reduce the level of permissions required. 24 | 25 | ## What do you need to do if you have Bitbucket repositories? 26 | 27 | The original user who set up your Bitbucket integration will need to log in to Codacy to confirm the new permissions. **Otherwise, Codacy will no longer be able to detect new Pull Requests, and existing repositories will stop receiving Pull Request status and comments on Bitbucket.** 28 | 29 | If the original user who set up your Bitbucket integration isn't available, someone who has Admin permissions in both Codacy and Bitbucket to [re-do the integration](../../repositories-configure/integrations/bitbucket-integration.md) in Codacy. 30 | 31 | You can log in with Bitbucket through . 32 | 33 | ![Logging in using Bitbucket](../images/2019-02-18-bitbucket-changes.png) 34 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-04-08.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud April 8, 2019. 5 | --- 6 | 7 | # Cloud April 8, 2019 8 | 9 | ## Bug fixes 10 | 11 | - Fixed a bug where some users weren't able to login to Codacy when using GitHub. This was related to the "Email permission" that was missing. With the fix, if that permission is missing users will now get redirected to GitHub to request for the missing permissions ("read email"), and upon authorizing they will be able to log in. 12 | - Fixed a bug that was causing TSLint analysis to fail due to an invalid configuration syntax. 13 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-05-05.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud May 5, 2019. 5 | --- 6 | 7 | # Cloud May 5, 2019 8 | 9 | ## Product enhancements 10 | 11 | We added the following plugins for ESLint: 12 | 13 | - [typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) 14 | - [eslint-plugin-relay](https://www.npmjs.com/package/eslint-plugin-relay) 15 | 16 | ## Bug fixes 17 | 18 | - Fixed a bug that was preventing accounts from being reactivated 19 | - Fixed a bug where we couldn't import any projects from a Bitbucket organization if there were problems with one team 20 | - Fixed a bug that forced the user to log in with Bitbucket to be able to see the Bitbucket projects. Now the user can log in with Bitbucket or GitHub and still be able to add projects from the other provider. 21 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-05-20.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud May 20, 2019. 5 | --- 6 | 7 | # Cloud May 20, 2019 8 | 9 | ## Product enhancements 10 | 11 | - As a way of improving performance and provide faster analysis, Codacy will no longer check for new updates in projects that don't have [post-commit hooks](../../repositories-configure/integrations/post-commit-hooks.md) enabled. 12 | 13 | ## Bug fixes 14 | 15 | - Fixed a bug where Go tools weren't reporting any issues in the first analysis. 16 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-06-18.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud June 18, 2019. 5 | --- 6 | 7 | # Cloud June 18, 2019 8 | 9 | ## Product enhancements 10 | 11 | - New plugin available for ESLint: [eslint-config-kentcdodds](https://github.com/kentcdodds/eslint-config-kentcdodds) 12 | 13 | ## Bug fixes 14 | 15 | - Fixed bug where Duplication would show incorrect values if the branch was changed 16 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-08-07.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud August 7, 2019. 5 | --- 6 | 7 | # Cloud August 7, 2019 8 | 9 | ## Product enhancements 10 | 11 | - New plugins available for ESLint: 12 | - [eslint-config-standard-jsx](https://www.npmjs.com/package/eslint-config-standard-jsx) 13 | - [eslint-plugin-compat](https://www.npmjs.com/package/eslint-plugin-compat) 14 | - [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly) 15 | - Updated bundler-audit to [v0.6.1](https://github.com/rubysec/bundler-audit/releases/tag/v0.6.1) 16 | - Updated ESLint to [v5.16.0](https://eslint.org/blog/2019/03/eslint-v5.16.0-released) 17 | - Updated RuboCop to [v0.71.0](https://github.com/rubocop-hq/rubocop/releases/tag/v0.71.0) 18 | - Keeping in line with the Git providers, Codacy will now ignore branches with names longer than 254 characters 19 | - Added new list view of team members under organizations called **People** 20 | 21 | ## Bug fixes 22 | 23 | - Fixed bug that, in some projects, was causing Complexity and Duplication to be incorrectly calculated 24 | - Fixed a bug where Complexity could show different results in different branches when the value should be the same 25 | - Fixed a bug where some issues could be found but not listed on the Pull Request 26 | - Fixed a bug that could cause the dashboards to not load correctly 27 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2019-11-15.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Cloud November 15, 2019. 5 | --- 6 | 7 | # Cloud November 15, 2019 8 | 9 | ## Product Enhancements 10 | 11 | Synced organizations for GitHub are live! 12 | 13 | This feature will allow for easier integration with GitHub and organization management. Here you can find our [documentation on the new features and how to use them](../../organizations/what-are-organizations.md). 14 | 15 | As a consequence, the next time you log in to Codacy you will see a window asking for one additional permission on GitHub with this information: 16 | 17 | ![Authorizing access to organizations](../images/2019-11-15-organizations-authorize.png) 18 | 19 | This will allow us to create an organization hook on GitHub for the new Synced organizations that will notify us whenever changes occur on GitHub. 20 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2020-02-github-apps.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Codacy now supports GitHub Apps February 2020 7 | 8 | We're changing the way you authenticate to Codacy with GitHub: Starting February 2020, when you sign in, you'll be prompted to use GitHub Apps. 9 | 10 | GitHub Apps are the new preferred way of building products that work with GitHub repositories. Unlike right now, where you must grant access to everything in your account, with Apps you'll be able to select which accounts, organizations, and repositories Codacy has access to. You can also grant access to more later. If you previously wanted to grant access to only one of your organizations or only a specific repository, Apps will have you covered. 11 | 12 | Using Apps also unlocks access to new APIs, like GitHub Checks for creating better pull request reviews. 13 | 14 | ![Installing the Codacy GitHub app](../images/2020-02-github-apps.gif) 15 | 16 | To migrate to Apps all you have to do is sign out, sign in to Codacy and follow the wizard requesting the new permissions. Existing integrations will continue to work. 17 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2020-03-09-nodesecurity-golint-scsslint-removal.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Removal of NodeSecurity, GoLint, and SCSSLint March 9, 2020 7 | 8 | On the week of March 9th 2020, we'll be removing some tools from Codacy. 9 | 10 | Those tools are NodeSecurity, GoLint, and SCSSLint. 11 | 12 | These tools have become deprecated or stopped being updated by their maintainers and started providing a bad experience for Codacy users either by reporting false positives or causing other unexpected issues. 13 | 14 | We've been working on alternatives for each tool. Continue reading to find out how you can replace each of the removed tools: 15 | 16 | - **NodeSecurity:** This tool detects outdated NPM dependencies. It stopped being maintained two years ago when [it was acquired and replaced by NPM](https://github.com/nodesecurity/nsp#the-node-security-platform-has-been-acquired-by-npm-inc) itself. Since it stopped being updated it will no longer find new vulnerabilities, thus becoming useless and only providing a false sense of security. _Recommendation: If you have an NPM repository you now have this functionality out-of-the-box._ 17 | - **GoLint:** Last month we launched a new Go tool - [Revive](https://github.com/mgechev/revive) - which is a drop-in replacement for GoLint supporting all its rules and even more. _Recommendation: Revive was enabled by default for your Go repositories with GoLint's. Check that the default patterns make sense for your team._ 18 | - **SCSSLint:** [This tool is now unmaintained](https://github.com/sds/scss-lint#notice-consider-other-tools-before-adopting-scss-lint) for four years with the old maintainers suggesting that users migrate to Stylelint which is already supported by Codacy for quite some time. _Recommendation: Check that the Stylelint is enabled and its default patterns make sense for your team._ 19 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2020-04-01-deprecating-http-headers-for-api-tokens.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: On April 1st, 2020 we're deprecating the api_token and project_token HTTP headers used to authenticate to the Codacy API. 5 | --- 6 | 7 | # Deprecating HTTP headers for API tokens April 1, 2020 8 | 9 | On April 1st, 2020 we're deprecating the following HTTP headers used to authenticate to the [Codacy API](https://api.codacy.com/api/api-docs) using either an API token or project token: 10 | 11 | - `api_token` 12 | - `project_token` 13 | 14 | From this date onward, use the following HTTP headers instead: 15 | 16 | - `api-token` 17 | - `project-token` 18 | 19 | ## How does this change impact me? 20 | 21 | We will support the new and old HTTP headers simultaneously for some time. However, we intend to drop the support for the old HTTP headers in the future. 22 | 23 | As such, to avoid downtime in your operations, we recommend that you do the following **as soon as possible**: 24 | 25 | - Update the [Codacy Coverage Reporter](https://github.com/codacy/codacy-coverage-reporter) to version 7.6.6 or later 26 | - Update the [Codacy Analysis CLI](https://github.com/codacy/codacy-analysis-cli) to version 3.0.0 or later 27 | - If you have any custom tools or scripts that integrate with the Codacy API, update them to use the new HTTP headers. 28 | 29 | ## Background information 30 | 31 | By default, [NGINX silently drops HTTP headers containing underscores](https://www.nginx.com/nginx-wiki/build/dirhtml/start/topics/tutorials/config_pitfalls/#missing-disappearing-http-headers). With the old HTTP headers, this would require an extra configuration step during the Codacy installation process. 32 | 33 | We decided to avoid this extra complexity by changing to the new HTTP headers that don't include underscores. 34 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2022-02-16-pmd-legacy-removal.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Removal of PMD (Legacy) February 16, 2022 7 | 8 | On the week of February 16th 2022 we'll be removing the tool **PMD (Legacy)** from Codacy. 9 | 10 | The **PMD (Legacy)** tool runs [PMD 5.8.1](https://github.com/pmd/pmd/releases/tag/pmd_releases%2F5.8.1), and was introduced to allow a smoother migration to PMD 6. 11 | 12 | However, the legacy version of PMD is almost five years old and is no longer being maintained by the tool developers, while PMD 6 is now very stable and provides newer features. 13 | 14 | ## If you were using PMD (Legacy) 15 | 16 | To continue using PMD to analyze your repositories, [enable the **PMD** tool](../../repositories-configure/configuring-code-patterns.md) on the **Code patterns** page of your repositories. 17 | 18 | If you have any questions or need help, please contact . 19 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2023-10-13-bundler-audit-deprecation.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Deprecation of bundler-audit October 13, 2023 7 | 8 | On October 13th 2023 we deprecated the tool **bundler-audit** in favor of [**Trivy**](https://github.com/codacy/codacy-trivy), a more complete and actively maintained tool for detecting vulnerabilities in Ruby gems and other languages, with a vulnerability database that's updated daily. 9 | 10 | ## Removal of bundler-audit January 1, 2024 11 | 12 | On January 1st, 2024 we'll be removing **bundler-audit** from Codacy. 13 | 14 | ## If you are using bundler-audit 15 | 16 | To continue monitoring your repositories for vulnerable Ruby gems, enable the **Trivy** tool in your [organization coding standards](../../organizations/using-coding-standards.md) (recommended) or on the [code patterns page](../../repositories-configure/configuring-code-patterns.md) of each of the affected repositories. 17 | 18 | For new repositories, **Trivy** will be active by default. 19 | 20 | If you have any questions or need help, please contact . 21 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2023-11-13-jira-slack-webhooks-repo-integrations-removal.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Removal of Jira, Slack, and Webhooks repository integrations November 13, 2023 7 | 8 | On the week of November 13th 2023 we removed the option to create, configure, and delete **Jira**, **Slack**, and **Webhooks integrations for your repositories**. These integrations were available on the repository **Settings**, tab **Integration**. 9 | 10 | Your existing integrations will keep working [until the end of 2023](#removal-of-existing-integrations). However, you can no longer configure or delete them on the Codacy app. 11 | 12 | Due to their limited adoption, these integrations haven't been maintained for some time and have started impacting the delivery of new features. Although there's no plan to make these integrations available again, we're open to looking into them upon feedback. 13 | 14 | ## Removal of existing integrations 15 | 16 | We're planning to remove the existing Jira, Slack, and Webhooks repository integrations from the Codacy app by the **end of 2023**. By this time, your existing integrations will stop working and we'll delete all related data, including authentication data. 17 | 18 | ## If you are using Jira, Slack, or Webhooks repository integrations 19 | 20 | If you have critical workflows relying on these integrations, please contact us at so we can advise on the best alternative. 21 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2024-09-adding-eslint9-and-pmd7.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Adding ESLint 9 and PMD 7 as new supported tools September, 2024 7 | 8 | On September, 2024 Codacy added ESLint 9 and PMD 7 as new supported tools and it will deprecate ESLint 8 and PMD 6 soon: 9 | 10 | - ESLint 9 and PMD 7 won't be enabled by default for new repositories. Update these tools version to benefit from the new features and fixes. 11 | 12 | - ESLint 8 and PMD 6 will still be available but Codacy will stop providing updates for this version of the tool, and it will be deprecated 13 | 14 | - ESLint 7 will be deleted 15 | 16 | ## Migrating your configuration files to use ESLint 9 17 | 18 | ESLint 9 [introduces breaking changes](https://eslint.org/blog/2024/04/eslint-v9.0.0-released/) that may affect the analysis of your repositories. 19 | 20 | **If you're using the following [ESLint configuration files](https://eslint.org/docs/user-guide/configuring/configuration-files) ".eslintrc.js", ".eslintrc.cjs", ".eslintrc.yaml", ".eslintrc.yml", ".eslintrc.json"** you must update your configuration file before enabling ESLint 9 on Codacy because the only **[ESLint configuration files](https://eslint.org/docs/user-guide/configuring/configuration-files) supported are "eslint.config.js", "eslint.config.mjs", "eslint.config.cjs" and you can check how to create them [here](https://eslint.org/docs/latest/use/configure/configuration-files)** 21 | 22 | If you have any questions or need help, please contact . 23 | 24 | ## PMD 7 25 | 26 | PMD 7 [introduces some changes](https://pmd.github.io/2024/03/22/PMD-7-is-here/) 27 | 28 | **PMD 7 now supports Kotlin, Swift and TypeScript, apart from the other languages already part of the previous version of the tool** 29 | 30 | If you have any questions or need help, please contact . 31 | -------------------------------------------------------------------------------- /docs/release-notes/cloud/cloud-2025-02-adding-ruff-lizard.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | --- 5 | 6 | # Adding Lizard and Ruff as new supported tools February, 2025 7 | 8 | ## Lizard 9 | 10 | With Lizard, Codacy can now detect and report code complexity issues across 15 different languages, helping developers write cleaner, more maintainable code. Specifically, it will: 11 | 12 | - Flag methods with cyclomatic complexity above the set threshold 13 | - Report functions that have too many parameters 14 | - Identify methods that exceed a reasonable number of lines (excluding comments) 15 | 16 | These insights will be available at the commit, PR, and file levels, integrated into GitHub and IDE, just like the issues reported by the other static analysis tools. 17 | 18 | ### Important Notes 19 | 20 | Not enabled by default (for now): Since Lizard may introduce a significant number of new issues, we’ve opted not to activate it by default (though this may change in the future) 21 | 22 | ### Tool vs. Metric 23 | 24 | Currently, Lizard operates as a tool, meaning it does not impact: 25 | 26 | - File-level complexity scores 27 | - Complexity Quality gates 28 | - Dashboard complexity metrics 29 | 30 | However, we plan to integrate it as a metric soon—stay tuned! 31 | 32 | ## Ruff 33 | 34 | We've increased our offering in Python tools and we added Ruff as our new tool for Quality. 35 | Ruff is a fast Python linter designed to be a drop-in replacement for tools like Flake8, isort, and Black. This tool significantly outperforms traditional Python linters, making it ideal for large codebases. Ruff supports over 500 linting rules and type-aware linting. 36 | 37 | Currently it's compatible with **Python up to 3.13** 38 | 39 | If you have any questions or need help, please contact . 40 | -------------------------------------------------------------------------------- /docs/release-notes/images/2019-02-18-bitbucket-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/2019-02-18-bitbucket-changes.png -------------------------------------------------------------------------------- /docs/release-notes/images/2019-11-15-organizations-authorize.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/2019-11-15-organizations-authorize.png -------------------------------------------------------------------------------- /docs/release-notes/images/2020-02-github-apps.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/2020-02-github-apps.gif -------------------------------------------------------------------------------- /docs/release-notes/images/2024-01-15-gh-updated-permissions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/2024-01-15-gh-updated-permissions.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-549.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-549.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-572.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-572.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-593.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-593.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-695-status-checks-bitbucket.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-695-status-checks-bitbucket.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-695-status-checks-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-695-status-checks-github.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-695-status-checks-gitlab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-695-status-checks-gitlab.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-695-update-status-checks-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-695-update-status-checks-github.png -------------------------------------------------------------------------------- /docs/release-notes/images/ala-824.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/ala-824.png -------------------------------------------------------------------------------- /docs/release-notes/images/cov-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cov-2.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-4196.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-4196.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-4216.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-4216.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-4654.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-4654.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5533.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5533.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5534.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5534.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5573.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5573.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5580.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5580.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5796.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5796.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5797.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5797.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5876.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5876.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-5960.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-5960.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-6021.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-6021.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-6336.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-6336.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-6455.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-6455.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-6612.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-6612.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-6855.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-6855.png -------------------------------------------------------------------------------- /docs/release-notes/images/cy-7305.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/cy-7305.png -------------------------------------------------------------------------------- /docs/release-notes/images/hrz-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/hrz-6.png -------------------------------------------------------------------------------- /docs/release-notes/images/io-152.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/io-152.png -------------------------------------------------------------------------------- /docs/release-notes/images/io-152b.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/io-152b.png -------------------------------------------------------------------------------- /docs/release-notes/images/io-358.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/io-358.png -------------------------------------------------------------------------------- /docs/release-notes/images/io-56.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/io-56.png -------------------------------------------------------------------------------- /docs/release-notes/images/io-92.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/io-92.png -------------------------------------------------------------------------------- /docs/release-notes/images/pluto-470.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/pluto-470.png -------------------------------------------------------------------------------- /docs/release-notes/images/pluto-484.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/pluto-484.png -------------------------------------------------------------------------------- /docs/release-notes/images/pluto-77.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/pluto-77.png -------------------------------------------------------------------------------- /docs/release-notes/images/tarot-2242.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/tarot-2242.png -------------------------------------------------------------------------------- /docs/release-notes/images/tarot-2546.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/release-notes/images/tarot-2546.png -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v1.0.0.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v1.0.0. 5 | --- 6 | 7 | # Self-hosted v1.0.0 8 | 9 | These release notes are for [Codacy Self-hosted v1.0.0](https://github.com/codacy/chart/releases/tag/1.0.0), released on May 18, 2020. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Product enhancements 14 | 15 | - Streamlined the configuration of Git providers and improved the onboarding flow that guides the user while performing the initial Codacy setup. (CY-468) 16 | 17 | ## Bug fixes 18 | 19 | - Fixed an issue that could cause pull requests to not be analyzed by improving the robustness of how Codacy fetches Git repositories. (CY-1542) 20 | - Fixed an issue that caused Codacy to fail to display the information for the pull request tabs **Hotspots** and **Diff**. (CY-1690) 21 | - Fixed an issue that prevented Codacy from analyzing repositories in synced organizations if the repositories had the state `OwnerNotCommiter`. (CY-1611) 22 | - Fixed an issue that prevented using the Codacy configuration file to exclude files from the coverage analysis. (CY-229) 23 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v1.0.1.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v1.0.1. 5 | --- 6 | 7 | # Self-hosted v1.0.1 8 | 9 | These release notes are for [Codacy Self-hosted v1.0.1](https://github.com/codacy/chart/releases/tag/1.0.1), released on May 21, 2020. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Bug fixes 14 | 15 | - Fixed an issue that caused the Helm deployment to time out because the Fluentd pods failed to start. (CY-1761) 16 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v1.1.0.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v1.1.0. 5 | --- 6 | 7 | # Self-hosted v1.1.0 8 | 9 | These release notes are for [Codacy Self-hosted v1.1.0](https://github.com/codacy/chart/releases/tag/1.1.0), released on May 26, 2020. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Product enhancements 14 | 15 | - The Profile and Access Management pages are now built using the React framework. (CY-83) 16 | - It's now possible to define custom values for the analysis inactivity timeout, analysis task timeout, and maximum analysis file size. (CY-1298) 17 | 18 | ## Bug fixes 19 | 20 | - Fixed an issue that sometimes caused logging into Codacy with GitLab Cloud to fail. (CY-1772) 21 | - Fixed an issue that caused the deletion of an account in Codacy to fail. (CY-1720) 22 | - Fixed an issue that could block Bitbucket Cloud and Bitbucket Server repositories from being added to Codacy if they contained spaces in the name. (CY-1717) 23 | - Fixed an issue that prevented pull request notification emails from being sent to the pull request authors. (CY-1678) 24 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v1.2.0.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v1.2.0. 5 | --- 6 | 7 | # Self-hosted v1.2.0 8 | 9 | These release notes are for [Codacy Self-hosted v1.2.0](https://github.com/codacy/chart/releases/tag/1.2.0), released on June 4, 2020. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Product enhancements 14 | 15 | - To avoid downtime, Codacy now automatically rolls the deployment when performing an Help upgrade. (CY-1420) 16 | - Now, Codacy doesn't allow the last Codacy administrator to delete its own account. (CY-1768) 17 | 18 | ## Bug fixes 19 | 20 | - Fixed an issue that prevented the correct removal of repositories from Codacy when the repositories were deleted on GitHub. (CY-1820) 21 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v1.3.0.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v1.3.0. 5 | --- 6 | 7 | # Self-hosted v1.3.0 8 | 9 | These release notes are for [Codacy Self-hosted v1.3.0](https://github.com/codacy/chart/releases/tag/1.3.0), released on June 12, 2020. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Bug fixes 14 | 15 | - Fixed misaligned organization cards in the onboarding screen UI. (CY-1864) 16 | - Fixed an issue to improve the security of the OAuth 2.0 access token when making calls to the Bitbucket Cloud API. (CY-1856) 17 | - Fixed alignment and wrong color of Git provider buttons when adding a new Git provider using Safari. (CY-1284) 18 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v1.4.0.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v1.4.0. 5 | --- 6 | 7 | # Self-hosted v1.4.0 8 | 9 | These release notes are for [Codacy Self-hosted v1.4.0](https://github.com/codacy/chart/releases/tag/1.4.0), released on June 23, 2020. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Bug fixes 14 | 15 | - Fixed an issue that could cause the list of repositories in an organization to display the repositories in the incorrect order. (CY-1940) 16 | - Fixed an issue that could prevent pull requests from being analyzed if they were created while Codacy was already performing an analysis. (CY-1902) 17 | - Fixed a UI issue affecting the Country drop-down box in the Plan and Billing page. (CY-1896) 18 | - Fixed broken layout of Codacy comments on pull requests by removing the Codacy logo. (CY-1819) 19 | - Fixed an UI issue affecting the list of default patterns under the account settings. (CY-522) 20 | - Improved the feedback message provided by Codacy when deactivating a pattern that already has detected issues. (CY-117) 21 | - Fixed an issue preventing the coverage information tab to be displayed in the page for specific files in the repository if the coverage was 0%. (CY-118) 22 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v2.1.1.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v2.1.1. 5 | --- 6 | 7 | # Self-hosted v2.1.1 8 | 9 | These release notes are for [Codacy Self-hosted v2.1.1](https://github.com/codacy/chart/releases/tag/2.1.1), released on September 24, 2020. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Bug fixes 14 | 15 | - Fixed an issue that prevented Codacy from detecting and analyzing new commits and pull requests in repositories belonging to synced organizations. This issue only affected repositories that didn't have a post-commit hook enabled and required Codacy to poll for changes. (CY-2781) 16 | 17 | ## Tool versions 18 | 19 | This version of Codacy Self-hosted includes the tool versions below. 20 | 21 | - Ameba 0.13.1 22 | - Bandit 1.6.2 23 | - Brakeman 4.3.1 24 | - bundler-audit 0.6.1 25 | - Checkstyle 8.34 26 | - CodeNarc 1.6 27 | - CoffeeLint 2.1.0 28 | - Cppcheck 2.1 29 | - Credo 1.3.0 30 | - CSSLint 1.0.5 31 | - detekt 1.10.0 32 | - ESLint 7.8.1 33 | - Flawfinder 2.0.11 34 | - Gorevive 1.0.2 35 | - Gosec v2.3.0 36 | - Hadolint 1.17.5 37 | - Jackson Linter 2.10.2 38 | - JSHint 2.10.2 39 | - PHP_CodeSniffer 3.5.6 40 | - Phpmd 2.8.1 41 | - PMD 6.27.0 42 | - Pmdjava 5.8.1 43 | - Prospector 1.2.0 44 | - PSScriptAnalyser 1.18.3 45 | - Pylint 1.9.5 46 | - Pylint Python3 2.6.0 47 | - Remark Lint 7.0.0 48 | - RuboCop 0.82.0 49 | - Scalastyle 1.0.0 50 | - ShellCheck 0.7.1 51 | - SonarC# 8.12 52 | - SonarVB 8.12 53 | - SpotBugs 4.1.2 54 | - SQLint 0.1.9 55 | - Staticcheck 2017.2.2 56 | - Stylelint 13.7.0 57 | - SwiftLint 0.39.2 58 | - Tailor 0.12.0 59 | - TSLint 5.14.0 60 | - TSQLLint 1.11.1 61 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v3.5.1.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v3.5.1. 5 | --- 6 | 7 | # Self-hosted v3.5.1 8 | 9 | These release notes are for [Codacy Self-hosted v3.5.1](https://github.com/codacy/chart/releases/tag/3.5.1), released on June 1, 2021. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Bug fixes 14 | 15 | - Fixed an issue that could allow reading information on Codacy related to unauthorized public repositories hosted on GitHub Enterprise Server. CVSS v3.1 score: 4.4 (Medium). (CY-4416) 16 | -------------------------------------------------------------------------------- /docs/release-notes/self-hosted/self-hosted-v4.0.1.md: -------------------------------------------------------------------------------- 1 | --- 2 | rss_title: Codacy release notes RSS feed 3 | rss_href: /feed_rss_created.xml 4 | description: Release notes for Codacy Self-hosted v4.0.1. 5 | --- 6 | 7 | # Self-hosted v4.0.1 8 | 9 | These release notes are for [Codacy Self-hosted v4.0.1](https://github.com/codacy/chart/releases/tag/4.0.1), released on June 2, 2021. 10 | 11 | To upgrade Codacy, follow [these instructions](../../chart/maintenance/upgrade.md). 12 | 13 | ## Bug fixes 14 | 15 | - Fixed an issue that could allow reading information on Codacy related to unauthorized public repositories hosted on GitHub Enterprise Server. CVSS v3.1 score: 4.4 (Medium). (CY-4416) 16 | -------------------------------------------------------------------------------- /docs/repositories-configure/adjusting-quality-goals.md: -------------------------------------------------------------------------------- 1 | # Adjusting quality goals 2 | 3 | Adjust the **quality goals** to help you monitor the progress of the code quality in your repository dashboard, and configure which files Codacy considers complex or duplicated. 4 | 5 | Codacy displays the quality goals as dashed lines on the [quality evolution chart](../repositories/repository-dashboard.md#quality-evolution-chart) to help you monitor the progress and overall quality status of your repository. 6 | 7 | To access the quality goals, open your repository **Settings**, tab **Goals**. The following screenshot displays the default configuration values: 8 | 9 | ![Quality goals](images/quality-settings-goals.png) 10 | 11 | - **Issues are over:** Defines the threshold displayed on the tab **Issues** of the quality evolution chart. 12 | - **Complexity is over:** Defines the threshold displayed on the tab **Complexity** of the quality evolution chart. 13 | - **File is complex when over:** A file is considered complex when its complexity is over this value. 14 | - **Duplication is over:** Defines the threshold displayed on the tab **Duplication** of the quality evolution chart. 15 | - **File is duplicate when over:** A file is considered duplicated when it has more clones than this value. 16 | - **Coverage is under:** Defines the threshold displayed on the tab **Coverage** of the quality evolution chart. 17 | 18 | ## See also 19 | 20 | - [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md) 21 | -------------------------------------------------------------------------------- /docs/repositories-configure/images/code-patterns-config-file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/code-patterns-config-file.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/code-patterns-configure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/code-patterns-configure.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/code-patterns-cs-customize-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/code-patterns-cs-customize-modal.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/code-patterns-cs-customize.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/code-patterns-cs-customize.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/code-patterns-toggle-tools.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/code-patterns-toggle-tools.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/code-patterns.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/code-patterns.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/disable-language.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/disable-language.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/file-extensions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/file-extensions.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/ignored-files-configuration-file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/ignored-files-configuration-file.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/ignored-files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/ignored-files.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/managing-branches-auto-enable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/managing-branches-auto-enable.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/managing-branches-sh.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/managing-branches-sh.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/managing-branches.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/managing-branches.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/quality-settings-gates.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/quality-settings-gates.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/quality-settings-goals.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/quality-settings-goals.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/repository-remove.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/repository-remove.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/using-submodules-default-add-user-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/using-submodules-default-add-user-key.png -------------------------------------------------------------------------------- /docs/repositories-configure/images/using-submodules-generate-new-user-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/images/using-submodules-generate-new-user-key.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/bitbucket-integration-ai-comment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/bitbucket-integration-ai-comment.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/bitbucket-integration-automatic-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/bitbucket-integration-automatic-summary.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/bitbucket-integration-pr-comment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/bitbucket-integration-pr-comment.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/bitbucket-integration-pr-status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/bitbucket-integration-pr-status.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/bitbucket-integration-pr-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/bitbucket-integration-pr-summary.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/bitbucket-integration-refresh.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/bitbucket-integration-refresh.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/bitbucket-integration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/bitbucket-integration.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration-ai-comment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration-ai-comment.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration-automatic-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration-automatic-summary.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration-coverage-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration-coverage-summary.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration-pr-annotation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration-pr-annotation.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration-pr-status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration-pr-status.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration-pr-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration-pr-summary.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration-suggest-fixes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration-suggest-fixes.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/github-integration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/github-integration.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/gitlab-integration-ai-comment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/gitlab-integration-ai-comment.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/gitlab-integration-pr-comment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/gitlab-integration-pr-comment.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/gitlab-integration-pr-status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/gitlab-integration-pr-status.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/gitlab-integration-pr-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/gitlab-integration-pr-summary.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/gitlab-integration-refresh.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/gitlab-integration-refresh.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/gitlab-integration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/gitlab-integration.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/images/post-commit-hook-create.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/integrations/images/post-commit-hook-create.png -------------------------------------------------------------------------------- /docs/repositories-configure/integrations/post-commit-hooks.md: -------------------------------------------------------------------------------- 1 | # Post-commit hooks 2 | 3 | When you add a new repository to Codacy, Codacy automatically creates a repository hook on your Git provider to check for new commits and pull requests. This post-commit hook enables Codacy to trigger an analysis to run immediately after you push code to your repository. 4 | 5 | !!! important 6 | Don't change the configuration of the hooks created by Codacy on your Git provider, as it might cause service failure. 7 | 8 | ## Creating a new post-commit hook 9 | 10 | In case your repository’s hook is missing from your Git provider, you can create a new one: 11 | 12 | 1. Open your repository **Settings**, tab **Integrations**. 13 | 1. On the **Post-commit hook** area, click the button **Create new hook**. 14 | 15 | ![Create post-commit hook](images/post-commit-hook-create.png) 16 | -------------------------------------------------------------------------------- /docs/repositories-configure/local-analysis/images/client-side-analysis-flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/local-analysis/images/client-side-analysis-flow.png -------------------------------------------------------------------------------- /docs/repositories-configure/local-analysis/images/run-analysis-through-build-server.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories-configure/local-analysis/images/run-analysis-through-build-server.png -------------------------------------------------------------------------------- /docs/repositories-configure/local-analysis/running-aligncheck.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: Instructions on how to run aligncheck as a client-side tool on Codacy. 3 | tool_name: aligncheck 4 | --- 5 | 6 | # Running aligncheck 7 | 8 | To run aligncheck as a [client-side tool](client-side-tools.md): 9 | 10 | 12 | {% 13 | include "../../assets/includes/client-side-tool-instructions.md" 14 | start="" 15 | end="" 16 | %} 17 | 18 | 1. Download and run the [Codacy Analysis CLI](https://github.com/codacy/codacy-analysis-cli#install) on the root of the repository, specifying the tool aligncheck. 19 | 20 | ```bash 21 | codacy-analysis-cli analyze --tool aligncheck \ 22 | --allow-network \ 23 | --upload \ 24 | --verbose 25 | ``` 26 | 27 | **If you're using an account API token**, you must also provide the flags `--provider`, `--username`, and `--project`. You can obtain the values for these flags from the URL of your repository dashboard on Codacy: 28 | 29 | ```bash 30 | codacy-analysis-cli analyze --provider \ 31 | --username \ 32 | --project \ 33 | --tool aligncheck \ 34 | --allow-network \ 35 | --upload \ 36 | --verbose 37 | ``` 38 | 39 | The Codacy Analysis CLI runs aligncheck on your repository and uploads the results to Codacy so you can use them in your workflow. 40 | 41 | {% 42 | include-markdown "../../assets/includes/client-side-tool-instructions.md" 43 | start="" 44 | end="" 45 | %} 46 | -------------------------------------------------------------------------------- /docs/repositories-configure/local-analysis/running-deadcode.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: Instructions on how to run deadcode as a client-side tool on Codacy. 3 | tool_name: deadcode 4 | --- 5 | 6 | # Running deadcode 7 | 8 | To run deadcode as a [client-side tool](client-side-tools.md): 9 | 10 | 12 | {% 13 | include "../../assets/includes/client-side-tool-instructions.md" 14 | start="" 15 | end="" 16 | %} 17 | 18 | 1. Download and run the [Codacy Analysis CLI](https://github.com/codacy/codacy-analysis-cli#install) on the root of the repository, specifying the tool deadcode. 19 | 20 | ```bash 21 | codacy-analysis-cli analyze --tool deadcode \ 22 | --allow-network \ 23 | --upload \ 24 | --verbose 25 | ``` 26 | 27 | **If you're using an account API token**, you must also provide the flags `--provider`, `--username`, and `--project`. You can obtain the values for these flags from the URL of your repository dashboard on Codacy: 28 | 29 | ```bash 30 | codacy-analysis-cli analyze --provider \ 31 | --username \ 32 | --project \ 33 | --tool deadcode \ 34 | --allow-network \ 35 | --upload \ 36 | --verbose 37 | ``` 38 | 39 | The Codacy Analysis CLI runs deadcode on your repository and uploads the results to Codacy so you can use them in your workflow. 40 | 41 | {% 42 | include-markdown "../../assets/includes/client-side-tool-instructions.md" 43 | start="" 44 | end="" 45 | %} 46 | -------------------------------------------------------------------------------- /docs/repositories-configure/removing-your-repository.md: -------------------------------------------------------------------------------- 1 | # Removing your repository 2 | 3 | To stop Codacy from analyzing your repository, you must remove the repository from Codacy. 4 | 5 | Removing a repository from Codacy completely removes the configurations and all data related to your repository from Codacy. This operation doesn't make any changes on your Git provider. 6 | 7 | !!! important 8 | To remove a repository from Codacy you must have [administrator permissions](../organizations/roles-and-permissions-for-organizations.md) for that repository on your Git provider. 9 | 10 | To delete your repository from Codacy: 11 | 12 | 1. Open your repository **Settings**, tab **General**. 13 | 14 | 1. Click the button **Remove repository** and confirm that you want to remove the repository. 15 | 16 | ![Removing your repository](images/repository-remove.png) 17 | 18 | !!! note 19 | For added security, after you remove the repository from Codacy you can delete from your Git provider the Codacy resources related to that repository to prevent their reuse: 20 | 21 | - Webhooks 22 | - SSH keys (GitLab and Bitbucket only) 23 | -------------------------------------------------------------------------------- /docs/repositories/images/commits-detail-quality-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-detail-quality-overview.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-detail-status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-detail-status.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-detail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-detail.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-tab-complexity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-tab-complexity.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-tab-coverage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-tab-coverage.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-tab-diff.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-tab-diff.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-tab-duplication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-tab-duplication.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-tab-files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-tab-files.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-tab-issues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-tab-issues.png -------------------------------------------------------------------------------- /docs/repositories/images/commits-view-logs-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits-view-logs-modal.png -------------------------------------------------------------------------------- /docs/repositories/images/commits.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/commits.png -------------------------------------------------------------------------------- /docs/repositories/images/coverage-metrics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/coverage-metrics.png -------------------------------------------------------------------------------- /docs/repositories/images/files-coverage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/files-coverage.png -------------------------------------------------------------------------------- /docs/repositories/images/files-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/files-details.png -------------------------------------------------------------------------------- /docs/repositories/images/files-duplication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/files-duplication.png -------------------------------------------------------------------------------- /docs/repositories/images/files-issues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/files-issues.png -------------------------------------------------------------------------------- /docs/repositories/images/files-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/files-search.png -------------------------------------------------------------------------------- /docs/repositories/images/files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/files.png -------------------------------------------------------------------------------- /docs/repositories/images/issues-detail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/issues-detail.png -------------------------------------------------------------------------------- /docs/repositories/images/issues-filter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/issues-filter.png -------------------------------------------------------------------------------- /docs/repositories/images/issues-fix-issues-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/issues-fix-issues-button.png -------------------------------------------------------------------------------- /docs/repositories/images/issues-fix-issues-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/issues-fix-issues-modal.png -------------------------------------------------------------------------------- /docs/repositories/images/issues-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/issues-menu.png -------------------------------------------------------------------------------- /docs/repositories/images/issues-unignore.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/issues-unignore.png -------------------------------------------------------------------------------- /docs/repositories/images/issues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/issues.png -------------------------------------------------------------------------------- /docs/repositories/images/low-covered-files-tables.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/low-covered-files-tables.png -------------------------------------------------------------------------------- /docs/repositories/images/open-pull-requests-widget.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/open-pull-requests-widget.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-detail-quality-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-detail-quality-overview.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-detail-status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-detail-status.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-detail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-detail.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-tab-commits.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-tab-commits.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-tab-complexity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-tab-complexity.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-tab-coverage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-tab-coverage.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-tab-diff.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-tab-diff.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-tab-duplication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-tab-duplication.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-tab-files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-tab-files.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-tab-issues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-tab-issues.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests-view-logs-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests-view-logs-modal.png -------------------------------------------------------------------------------- /docs/repositories/images/pull-requests.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/pull-requests.png -------------------------------------------------------------------------------- /docs/repositories/images/repository-dashboard-coverage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/repository-dashboard-coverage.png -------------------------------------------------------------------------------- /docs/repositories/images/repository-dashboard-issues-breakdown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/repository-dashboard-issues-breakdown.png -------------------------------------------------------------------------------- /docs/repositories/images/repository-dashboard-open-pull-requests.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/repository-dashboard-open-pull-requests.png -------------------------------------------------------------------------------- /docs/repositories/images/repository-dashboard-quality-evolution.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/repository-dashboard-quality-evolution.png -------------------------------------------------------------------------------- /docs/repositories/images/repository-dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codacy/docs/91b910fd9624d551a0bfb56dd93864a518f9534c/docs/repositories/images/repository-dashboard.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs==1.6.1 2 | mike==2.1.3 3 | markdown==3.7 4 | mkdocs-material==8.2.3 5 | Jinja2==3.1.4 6 | 7 | # Markdown extensions 8 | Pygments==2.18.0 9 | pymdown-extensions==10.11.2 10 | 11 | # MkDocs plugins 12 | mkdocs-exclude-search==0.6.6 13 | mkdocs-exclude==1.0.2 14 | mkdocs-git-revision-date-localized-plugin==1.2.9 15 | mkdocs-include-markdown-plugin==6.2.2 16 | mkdocs-macros-plugin==1.2.0 17 | mkdocs-meta-descriptions-plugin==3.0.0 18 | mkdocs-monorepo-plugin==1.1.0 19 | mkdocs-redirects==1.2.1 20 | mkdocs-rss-plugin==1.15.0 21 | -------------------------------------------------------------------------------- /tools/find-unused-images.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | DOCUMENTATION_PATH="../site" 4 | 5 | find "$DOCUMENTATION_PATH" -name "*.png" > /tmp/patterns 6 | find "$DOCUMENTATION_PATH" -name "*.gif" >> /tmp/patterns 7 | find "$DOCUMENTATION_PATH" -name "*.jpg" >> /tmp/patterns 8 | 9 | for p in $(cat /tmp/patterns); do 10 | f="$(basename "$p")"; 11 | grep -R "$f" "$DOCUMENTATION_PATH" > /dev/null || echo "$p"; 12 | done 13 | -------------------------------------------------------------------------------- /tools/get-tool-descriptions.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import argh 3 | import emoji 4 | import requests 5 | 6 | ENDPOINT_URL = "https://api.codacy.com/api/v3/tools" 7 | 8 | 9 | def get_tool_descriptions(verbose=False): 10 | tools = requests.get(ENDPOINT_URL).json()["data"] 11 | count = 0 12 | for tool in tools: 13 | tool_name = tool["name"] 14 | tool_description = tool.get("description", "") 15 | if tool_description == "": 16 | count += 1 17 | print(f"## {tool_name}\n" 18 | f"{tool_description if tool_description else 'Not available'}\n\n") 19 | if count: 20 | print(f"Found {count} tools without description.") 21 | exit(1) 22 | else: 23 | print(emoji.emojize("All tools have a description! :party_popper:")) 24 | exit(0) 25 | 26 | 27 | argh.dispatch_command(get_tool_descriptions) 28 | -------------------------------------------------------------------------------- /tools/list-last-modified.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import argh 3 | import csv 4 | import emoji 5 | import requests 6 | import xmltodict 7 | 8 | from bs4 import BeautifulSoup 9 | from tqdm import tqdm 10 | 11 | SITEMAP_URL = "https://docs.codacy.com/sitemap.xml" 12 | OUTPUT_FILE = "last-modified.csv" 13 | 14 | 15 | def list_last_modified(): 16 | # Parse sitemap to obtain list of page URLs 17 | print(f"Parsing {SITEMAP_URL}...") 18 | xml = requests.get(SITEMAP_URL).text 19 | sitemap = xmltodict.parse(xml) 20 | urls = [r["loc"] for r in sitemap["urlset"]["url"]] 21 | 22 | # Obtain last modified date for each page 23 | print(f"Found {len(urls)} pages.") 24 | result = {} 25 | for url in tqdm(urls, desc="Fetching last modify dates", unit="pages"): 26 | html = requests.get(url) 27 | last_modified = \ 28 | BeautifulSoup(html.text, "html.parser").select_one("meta[http-equiv=\"last-modified\"]").get("content") 29 | result[url] = last_modified 30 | 31 | # Write CSV file 32 | with open(OUTPUT_FILE, "w") as csv_file: 33 | csv_writer = csv.writer(csv_file) 34 | csv_writer.writerow(["Page", "Last modified date"]) 35 | for page in sorted(result.items()): 36 | csv_writer.writerow([page[0], page[1]]) 37 | print(emoji.emojize(f":check_mark_button: Wrote results to {OUTPUT_FILE}")) 38 | 39 | 40 | argh.dispatch_command(list_last_modified) 41 | -------------------------------------------------------------------------------- /tools/list-tool-short-names.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | curl -s -X GET https://api.codacy.com/api/v3/tools | jq '.data|=sort_by(.shortName|ascii_downcase) | .data[] | select(.clientSide == false) | .shortName' | sed 's/"//g' 4 | -------------------------------------------------------------------------------- /tools/requirements.txt: -------------------------------------------------------------------------------- 1 | argh 2 | beautifulsoup4 3 | emoji 4 | requests 5 | tqdm 6 | xmltodict 7 | --------------------------------------------------------------------------------