Skip to content

Commit

Permalink
feat: Remove "bulk copy patterns" and "import from repo" ALA-904 (#2049)
Browse files Browse the repository at this point in the history
* feat: Remove bulk copy code patterns

* feat: Remove import patterns from repo

* feat: Add screenshot placeholders

* feat: Update final screenshots for code patterns

* clean: Remove screenshot confirmation TODO

---------

Co-authored-by: Cláudia Carpinteiro <[email protected]>
Co-authored-by: Cláudia Carpinteiro <[email protected]>
  • Loading branch information
3 people authored Mar 20, 2024
1 parent 21c0347 commit 7b08816
Show file tree
Hide file tree
Showing 23 changed files with 5 additions and 95 deletions.
38 changes: 0 additions & 38 deletions docs/organizations/copying-code-patterns-between-repositories.md

This file was deleted.

Binary file modified docs/organizations/images/coding-standard-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/coding-standard-delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/coding-standard-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/coding-standard-set-default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/gate-policy-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/gate-policy-delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/gate-policy-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/gate-policy-set-default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/organizations/roles-and-permissions-for-organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The table below maps the GitHub Cloud and GitHub Enterprise roles to the corresp
<td class="yes">Yes</td>
</tr>
<tr>
<td>Manage organization gate policies and coding standards,<br/>bulk copy patterns</td>
<td>Manage organization gate policies and coding standards</td>
<td class="no">No</td>
<td colspan="2" class="no">No</td>
<td colspan="2" class="no">No</td>
Expand Down Expand Up @@ -282,7 +282,7 @@ The table below maps the GitLab Cloud and GitLab Enterprise roles to the corresp
<td colspan="2" class="yes">Yes</td>
</tr>
<tr>
<td>Manage organization gate policies and coding standards,<br/>bulk copy patterns</td>
<td>Manage organization gate policies and coding standards</td>
<td class="no">No</td>
<td colspan="2" class="no">No</td>
<td class="no">No</td>
Expand Down Expand Up @@ -400,7 +400,7 @@ The table below maps the Bitbucket Cloud and Bitbucket Server roles to the corre
<td class="yes">Yes</td>
</tr>
<tr>
<td>Manage organization gate policies and coding standards,<br/>bulk copy patterns</td>
<td>Manage organization gate policies and coding standards</td>
<td colspan="2" class="no">No</td>
<td class="yes">Yes</td>
<td class="yes">Yes</td>
Expand Down
2 changes: 0 additions & 2 deletions docs/organizations/using-coding-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,5 @@ When using a [tool configuration file](../repositories-configure/configuring-cod

## See also

- [Copying code patterns between repositories](copying-code-patterns-between-repositories.md)
- [Importing pattern configurations from another repository](../repositories-configure/configuring-code-patterns.md#import-patterns)
- [Configuring code patterns on each repository](../repositories-configure/configuring-code-patterns.md)
- [How to implement Google JavaScript style guide with Codacy](https://blog.codacy.com/implement-google-javascript-style-guide-with-codacy/)
42 changes: 1 addition & 41 deletions docs/repositories-configure/configuring-code-patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ description: Configure the static analysis tools and code patterns that Codacy u

{% include-markdown "../assets/includes/admin-access-control-info.md" %}

By default, Codacy analyzes your repositories using a subset of the supported analysis tools and code patterns. These defaults are based on current best practices and community feedback, and you can adapt them to your needs in several ways:
By default, Codacy analyzes your repositories using a subset of the supported analysis tools and code patterns. These defaults are based on current best practices and community feedback, and you can adapt them to your needs as follows:

- [Configuring tools and code patterns using the Codacy UI](#configuring-tools-and-code-patterns-using-the-codacy-ui)
- [Importing configurations from another repository](#import-patterns)
- [Using tool configuration files](#using-your-own-tool-configuration-files)

## Configuring tools and code patterns using the Codacy UI
Expand Down Expand Up @@ -40,44 +39,6 @@ To configure the tools and code patterns for a repository using the Codacy UI:

1. Optionally, to take the changes into account immediately, [reanalyze the repository manually](../faq/repositories/how-do-i-reanalyze-my-repository.md). Otherwise, Codacy will use the updated configuration when analyzing new commits and pull requests.

## Importing pattern configurations from another repository {: id="import-patterns"}

Importing tool and code pattern configurations from another repository can help you bootstrap and standardize the tool and code pattern configurations across your repositories.

For example, when adding a new repository on Codacy you can copy the tool and code pattern configurations from an existing repository that's already configured, and then tweak and adapt the settings for your new repository.

!!! tip
To ensure that multiple repositories consistently follow the same global tool and code pattern configurations, [use an organization coding standard](../organizations/using-coding-standards.md) instead.

Alternatively, you can also copy the tool and code pattern configurations [from one repository to multiple target repositories](../organizations/copying-code-patterns-between-repositories.md).

<!--code-patterns-copy-start-->
!!! important
Consider the following when using this feature:

- **Tool matching:** Codacy only copies settings for tools that are available on both the source and target repositories, and overwrites the existing settings for these tools on the target repository.
- **Toggle status:** Codacy copies the enabled or disabled status of the matching tools from the source to the target repository.
- **Configuration files:** Codacy copies the UI configuration of all matching tools, even those set to use configuration files. However, the import doesn't include the configuration mode itself and doesn't copy configuration files across repositories.

The following example illustrates the points above:

| Source repository | Target repository | Target repository after import |
|-------------------|-------------------|--------------------------------|
| ![Source repository](images/code-patterns-import-example-source.svg) | ![Target repository](images/code-patterns-import-example-target.svg) | ![Target repository after import](images/code-patterns-import-example-final.svg) |
<!--code-patterns-copy-end-->

To import the tool and code pattern configurations from another repository:

1. Open your repository **Code patterns** and click **Import patterns**.

![Importing code patterns from another repository](images/code-patterns-import.png)

1. Follow the instructions to select the source repository and complete the import.

1. Review and adjust your tool and code pattern configurations if necessary.

Codacy will use the updated configurations on the next analysis.

## Using tool configuration files {: id="using-your-own-tool-configuration-files"}

<!--NOTE
Expand Down Expand Up @@ -324,5 +285,4 @@ The table below lists the configuration file names that Codacy detects and suppo
## See also

- [Applying a coding standard across multiple repositories](../organizations/using-coding-standards.md)
- [Copying code patterns between repositories](../organizations/copying-code-patterns-between-repositories.md)
- [How to implement Google JavaScript style guide with Codacy](https://blog.codacy.com/implement-google-javascript-style-guide-with-codacy/)
Binary file modified docs/repositories-configure/images/code-patterns-config-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/repositories-configure/images/code-patterns-configure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 7b08816

Please sign in to comment.