Skip to content

Commit

Permalink
adding bitbucket projects information
Browse files Browse the repository at this point in the history
  • Loading branch information
RaquelHipolito authored and andrzej-janczak committed Oct 18, 2024
1 parent 307fcd7 commit dbe06f1
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/organizations/segments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Segments
Segments are dimensions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today, Segments is available for: [GitHub Custom Properties](#github-custom-properties)
Segments are dimensions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today, Segments is available for:
- [GitHub Custom Properties](#github-custom-properties)
- [BitBucket Projects](#bitbucket-projects)

Check failure on line 4 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'. Raw Output: {"message": "[Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 4, "column": 4}}}, "severity": "ERROR"}


## Where can Segments be utilised?
Expand All @@ -14,15 +16,24 @@ To enable Segments, an initial sync between your provider and Codacy needs to ha


### GitHub Custom Properties {: id="github-custom-properties"}
Create, use, and manage custom properties for your repositories directly in GitHub. Custom properties allow you to assign tags or metadata to repositories, making it easier to categorize and filter them.
Custom properties allow you to assign tags or metadata to repositories, making it easier to categorize and filter them. Create, use, and manage custom properties for your repositories directly in GitHub.

> Refer to [GitHub's official documentation](https://docs.github.com/en/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization#adding-custom-properties) for detailed steps on how to add, edit, and manage repository **Custom Properties**.
#### Keep Segments in sync
For changes to repository **Custom Properties** in GitHub to be **automatically** reflected in Codacy, users need to [accept the new permission request made by the Codacy GitHub app](https://docs.github.com/en/apps/using-github-apps/approving-updated-permissions-for-a-github-app).
!!! note
If the permission is **not accepted**, users will still be able to use Repository Custom Properties as filters in Codacy, but will need to manually trigger a sync. This can be done using the **manual sync** button available in the filter dropdown, which allows users to synchronize changes from GitHub, though the process may take longer.


### BitBucket Projects {: id="bitbucket-projects"}

Check failure on line 28 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'. Raw Output: {"message": "[Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 28, "column": 5}}}, "severity": "ERROR"}
BitBucket Projects allow you to organize your repositories into relevant contexts for you, making it easier to categorize and filter them. Create, use, and manage Projects for your repositories directly in Bitbucket.

Check failure on line 29 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'. Raw Output: {"message": "[Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 29, "column": 1}}}, "severity": "ERROR"}

> Refer to [BitBucket's official documentation](https://support.atlassian.com/bitbucket-cloud/docs/create-a-project/) for detailed steps on how to add, edit, and manage **Projects**.

Check failure on line 31 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'. Raw Output: {"message": "[Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 31, "column": 13}}}, "severity": "ERROR"}
#### Keep Segments in sync
After the first sync is done, BitBucket Prjects will continually be in sync with Codacy automatically.

Check failure on line 34 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'. Raw Output: {"message": "[Vale.Terms] Use 'Bitbucket' instead of 'BitBucket'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 34, "column": 31}}}, "severity": "ERROR"}

Check failure on line 34 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Prjects'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Prjects'?", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 34, "column": 41}}}, "severity": "ERROR"}

Check warning on line 34 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Adverbs] Consider removing 'continually'. Raw Output: {"message": "[Microsoft.Adverbs] Consider removing 'continually'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 34, "column": 54}}}, "severity": "WARNING"}


<br><br>
***
#### Check out what's new, and to come, in Codacy
Expand Down

0 comments on commit dbe06f1

Please sign in to comment.