Toggle Apply to new repositoriet on the relevant coding standard card.
+Toggle Apply to new repositories on the relevant coding standard card.
Share your feedback 📢
- Last modified August 20, 2024
+ Last modified August 27, 2024
diff --git a/repositories-configure/configuring-code-patterns/index.html b/repositories-configure/configuring-code-patterns/index.html
index ed8525da24..e67b8487cd 100644
--- a/repositories-configure/configuring-code-patterns/index.html
+++ b/repositories-configure/configuring-code-patterns/index.html
@@ -11,7 +11,7 @@
-
+
@@ -548,8 +548,8 @@
Configuring too
Optionally, to take the changes into account immediately, reanalyze the repository manually. Otherwise, Codacy will use the updated configuration when analyzing new commits and pull requests.
-Detaching a coding standard from a repository#
-If the repository is following a coding standard, a notice is displayed. To detach the coding standard from the repository, click Detach repository and confirm.
-
Customizing applied coding standards#
+To apply or edit a repository's coding standards, click Customize in the Following ... section at the top of the Code patterns page.
+
Select the coding standards that you want to follow or stop following and click Apply.
+
Using tool configuration files#
Note
@@ -4738,7 +4740,7 @@Share your feedback 📢
- Last modified August 12, 2024
+ Last modified August 27, 2024
diff --git a/repositories-configure/images/code-patterns-config-file.png b/repositories-configure/images/code-patterns-config-file.png
index 6ff884eaab..8c01253bea 100644
Binary files a/repositories-configure/images/code-patterns-config-file.png and b/repositories-configure/images/code-patterns-config-file.png differ
diff --git a/repositories-configure/images/code-patterns-cs-customize-modal.png b/repositories-configure/images/code-patterns-cs-customize-modal.png
new file mode 100644
index 0000000000..cde8b55352
Binary files /dev/null and b/repositories-configure/images/code-patterns-cs-customize-modal.png differ
diff --git a/repositories-configure/images/code-patterns-cs-customize.png b/repositories-configure/images/code-patterns-cs-customize.png
new file mode 100644
index 0000000000..ff25539623
Binary files /dev/null and b/repositories-configure/images/code-patterns-cs-customize.png differ
diff --git a/repositories-configure/images/code-patterns.png b/repositories-configure/images/code-patterns.png
index c9054bc373..8a2027744f 100644
Binary files a/repositories-configure/images/code-patterns.png and b/repositories-configure/images/code-patterns.png differ
diff --git a/search/search_index.json b/search/search_index.json
index c675e61c23..961020d068 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config": {"indexing": "full", "lang": ["en"], "min_search_length": 3, "prebuild_index": false, "separator": "[\\s\\-]+"}, "docs": [{"location": "", "text": "Documentation home # Getting started Adding your first repository (5 min) Sign up with your Git provider so that Codacy can have access to your Git provider organizations and members. You can then add any repository you have access to with one click. Supported languages Codacy supports over 40 programming languages and infrastructure-as-code platforms out of the box, and regularly adds support for new languages and tools. Using Codacy Creating and managing an organization Codacy automatically imports your Git provider organizations and members. Changes reflect on Codacy in real time and you can manage people who joined your organization on Codacy. Setting up integrations Configure Codacy to provide analysis feedback and status checks directly on your pull requests. Most popular topics Managing people in organizations Invite your teammates to join Codacy to analyze their commits on private repositories. Adding coverage to your repository Set up your repositories to show code coverage reports directly on Codacy. Using the Codacy API Retrieve and analyze data from Codacy and perform configuration changes programmatically", "title": "Documentation home"}, {"location": "#documentation-home", "text": "Getting started Adding your first repository (5 min) Sign up with your Git provider so that Codacy can have access to your Git provider organizations and members. You can then add any repository you have access to with one click. Supported languages Codacy supports over 40 programming languages and infrastructure-as-code platforms out of the box, and regularly adds support for new languages and tools. Using Codacy Creating and managing an organization Codacy automatically imports your Git provider organizations and members. Changes reflect on Codacy in real time and you can manage people who joined your organization on Codacy. Setting up integrations Configure Codacy to provide analysis feedback and status checks directly on your pull requests.", "title": "Documentation home"}, {"location": "special-thanks/", "text": "Special thanks # We would like to thank everyone who helped us greatly . The names on these lists contributed immensely to what Codacy is today. Open source tools # In addition to in-house built rules, we use open source tools for many of our static analysis. We want to express our gratitude to everyone who contributed to those tools. SonarC# PMD Brakeman RuboCop SimpleCov CoffeeLint Pylint SonarVB PHPMD PHP_CodeSniffer Mocha Scalastyle CSSLint radon Clone Digger PHPCPD plato sloc LessLinter Hadolint SCSSLint Credo PSScriptAnalyzer Ameba Language support contributions # These are the tools integrated on Codacy by our own users! Without them, we wouldn't have support for these languages. Language Who made it possible CoffeeScript Ryan Delaney Elixir Grant McLendon PowerShell Aditya Patwardhan Crystal Vitalii Elenhaupt Collaborators # For all the people who helped us so much, we want to give a big shout out and thanks! David Pate Adriaan Moors Iulian Dragos Jakob Pupke Mathieu Demarne Ryan Shipp Eugene Burmako", "title": "Special thanks"}, {"location": "special-thanks/#special-thanks", "text": "We would like to thank everyone who helped us greatly . The names on these lists contributed immensely to what Codacy is today.", "title": "Special thanks"}, {"location": "special-thanks/#open-source-tools", "text": "In addition to in-house built rules, we use open source tools for many of our static analysis. We want to express our gratitude to everyone who contributed to those tools. SonarC# PMD Brakeman RuboCop SimpleCov CoffeeLint Pylint SonarVB PHPMD PHP_CodeSniffer Mocha Scalastyle CSSLint radon Clone Digger PHPCPD plato sloc LessLinter Hadolint SCSSLint Credo PSScriptAnalyzer Ameba", "title": "Open source tools"}, {"location": "special-thanks/#language-support-contributions", "text": "These are the tools integrated on Codacy by our own users! Without them, we wouldn't have support for these languages. Language Who made it possible CoffeeScript Ryan Delaney Elixir Grant McLendon PowerShell Aditya Patwardhan Crystal Vitalii Elenhaupt", "title": "Language support contributions"}, {"location": "special-thanks/#collaborators", "text": "For all the people who helped us so much, we want to give a big shout out and thanks! David Pate Adriaan Moors Iulian Dragos Jakob Pupke Mathieu Demarne Ryan Shipp Eugene Burmako", "title": "Collaborators"}, {"location": "account/emails/", "text": "Emails # To manage the email addresses associated with your account and your email notifications, click on your avatar on the top right-hand corner and open Your account , page Emails . Updating your email addresses # Codacy automatically links to your Codacy account the email addresses from the Git provider associated with your current session. On the Emails page, you can verify which email addresses are linked to your Codacy account. Note For GitHub , if you have email privacy enabled on the provider, Codacy doesn't show your private emails and uses another available email address when displaying your personal details on lists, search filters, or activity. To update the email addresses associated with your Codacy account, do the following: Configure your Git email address . This ensures that commits are attributed to you. Update your email addresses on your Git provider ( GitHub , Bitbucket , or GitLab ). Log out and log back in to Codacy. Tip If the updates are still not reflected on Codacy, navigate to the access management page, revoke the relevant Git provider integration, then log out and back in to Codacy using the same provider. Note When developers commit from GitHub or Bitbucket , Codacy automatically associates all the commit email addresses from the same Git provider user with a single Codacy committer. For developers that never logged in to the Codacy app, this mechanism requires that they set their Git email address and add all their email addresses to their GitHub account or Bitbucket account . Setting your Git email address # Unless you explicitly configure your email address , Git automatically uses an email address based on the username and hostname of your workstation, and associates this email address with your commits. To check which email address your local Git installation is using, run the following command on your workstation: git config user.email If the returned email address isn't one of the email addresses associated with your Git provider account, configure Git to use one of those email addresses instead: git config --global user.email you@example.com Important Make sure that your email address doesn't include any extra characters such as quotes ( \"\" or '' ). Managing your email notifications # Codacy can send you an email whenever there are new analysis results on your repositories with the list of found issues and the changes that created them. Codacy sends all email notifications to your default email address, and you can change your default email address by clicking make default next to another email address. Configure the notifications that you wish to receive under Repository notifications : Per commit: Codacy will send you an email for each analyzed commit. Per pull request: Codacy will send you an email for each analyzed pull request. Only my activity: By default, Codacy will only send you emails about your own commits and pull requests. Turn off this setting to receive emails for commits and pull requests made by other people as well. Tip To turn off all email notifications, disable the settings Per commit and Per pull request .", "title": "Emails"}, {"location": "account/emails/#emails", "text": "To manage the email addresses associated with your account and your email notifications, click on your avatar on the top right-hand corner and open Your account , page Emails .", "title": "Emails"}, {"location": "account/emails/#updating", "text": "Codacy automatically links to your Codacy account the email addresses from the Git provider associated with your current session. On the Emails page, you can verify which email addresses are linked to your Codacy account. Note For GitHub , if you have email privacy enabled on the provider, Codacy doesn't show your private emails and uses another available email address when displaying your personal details on lists, search filters, or activity. To update the email addresses associated with your Codacy account, do the following: Configure your Git email address . This ensures that commits are attributed to you. Update your email addresses on your Git provider ( GitHub , Bitbucket , or GitLab ). Log out and log back in to Codacy. Tip If the updates are still not reflected on Codacy, navigate to the access management page, revoke the relevant Git provider integration, then log out and back in to Codacy using the same provider. Note When developers commit from GitHub or Bitbucket , Codacy automatically associates all the commit email addresses from the same Git provider user with a single Codacy committer. For developers that never logged in to the Codacy app, this mechanism requires that they set their Git email address and add all their email addresses to their GitHub account or Bitbucket account .", "title": "Updating your email addresses"}, {"location": "account/emails/#managing-your-email-notifications", "text": "Codacy can send you an email whenever there are new analysis results on your repositories with the list of found issues and the changes that created them. Codacy sends all email notifications to your default email address, and you can change your default email address by clicking make default next to another email address. Configure the notifications that you wish to receive under Repository notifications : Per commit: Codacy will send you an email for each analyzed commit. Per pull request: Codacy will send you an email for each analyzed pull request. Only my activity: By default, Codacy will only send you emails about your own commits and pull requests. Turn off this setting to receive emails for commits and pull requests made by other people as well. Tip To turn off all email notifications, disable the settings Per commit and Per pull request .", "title": "Managing your email notifications"}, {"location": "account/managing-your-profile/", "text": "Managing your profile # 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 . Changing your name or avatar # To change your avatar, sign up or log in at Gravatar 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. Note Organization avatars aren't editable at the moment. To change your name, update the field Name and click the button Update profile . Deleting your account # When you delete your account on Codacy: Your profile information and all data related to your personal repositories are completely removed from Codacy Codacy will stop analyzing any repositories added to Codacy using your account This operation doesn't make any changes on your Git provider. To delete your account, click the button Delete account and confirm that you really want to proceed. Note 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 before you can delete your account.", "title": "Managing your profile"}, {"location": "account/managing-your-profile/#managing-your-profile", "text": "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 .", "title": "Managing your profile"}, {"location": "account/managing-your-profile/#changing-your-name-or-avatar", "text": "To change your avatar, sign up or log in at Gravatar 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. Note Organization avatars aren't editable at the moment. To change your name, update the field Name and click the button Update profile .", "title": "Changing your name or avatar"}, {"location": "account/managing-your-profile/#deleting-your-account", "text": "When you delete your account on Codacy: Your profile information and all data related to your personal repositories are completely removed from Codacy Codacy will stop analyzing any repositories added to Codacy using your account This operation doesn't make any changes on your Git provider. To delete your account, click the button Delete account and confirm that you really want to proceed. Note 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 before you can delete your account.", "title": "Deleting your account"}, {"location": "account/user-session-management/", "text": "User session management # 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. Idle session timeout # 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. Absolute session timeout # 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.", "title": "User session management"}, {"location": "account/user-session-management/#user-session-management", "text": "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.", "title": "User session management"}, {"location": "account/user-session-management/#idle-session-timeout", "text": "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.", "title": "Idle session timeout"}, {"location": "account/user-session-management/#absolute-session-timeout", "text": "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.", "title": "Absolute session timeout"}, {"location": "chart/", "text": "Installing Codacy Self-hosted # This documentation guides you on how to install Codacy Self-hosted on Kubernetes or MicroK8s. Important If you're running the legacy Codacy Self-hosted solution running on Docker please contact support@codacy.com so that we can assist you with the migration to Codacy Self-hosted running on Kubernetes or MicroK8s. To install Codacy you must complete these main steps: Setting up the system requirements Ensure that your infrastructure meets the hardware and system requirements to run Codacy. Installing Codacy Install Codacy on the cluster using our Helm chart that includes all the necessary components and dependencies. Configuring Codacy Configure integrations with Git providers and set up monitoring. The next sections include detailed instructions on how to complete each step of the installation process. Make sure that you complete each step before advancing to the next one. 1. Setting up the system requirements # Before you start, you must prepare and provision the database server and Kubernetes or MicroK8s cluster that will host Codacy. Carefully review and set up the system requirements to run Codacy by following the instructions on the page below: System requirements Optionally, you can follow one of the guides below to quickly create a new Kubernetes or MicroK8s cluster that satisfies the characteristics described in the system requirements: Creating an Amazon EKS cluster Creating a MicroK8s cluster 2. Installing Codacy # Install Codacy on an existing cluster using our Helm chart: Make sure that you have the following tools installed on your machine: kubectl within one minor version difference of your cluster Important If you're using MicroK8s you don't need to install kubectl because you will execute all kubectl commands as microk8s.kubectl commands instead. To simplify this, check how to create an alias for kubectl . Helm version >= 3.9 Create a cluster namespace called codacy that will group all resources related to Codacy. kubectl create namespace codacy Add the Docker registry credentials provided by Codacy together with your license to a cluster Secret. This is necessary because some Codacy Docker images are currently private. Substitute