Skip to content

PLUTO-1090 Segments Bitbucket #2233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrzej-janczak merged 5 commits into from
Oct 30, 2024
Merged

PLUTO-1090 Segments Bitbucket #2233

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dbe06f1
adding bitbucket projects information
RaquelHipolito Oct 15, 2024
24ba01b
correcting BitBucket to Bitbucket
RaquelHipolito Oct 18, 2024
6bf3fe0
Merge branch 'master' into PLUTO-1090-segments-bitbucket
RaquelHipolito Oct 23, 2024
f6bbd55
Merge branch 'master' into PLUTO-1090-segments-bitbucket
RaquelHipolito Oct 30, 2024
221134b
correct typos
RaquelHipolito Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions docs/organizations/segments.md
View file
Open in desktop
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)


## Where can Segments be utilised?
Expand All @@ -14,15 +16,24 @@


### 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
#### Keep Segments insync

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'insync'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'insync'?", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 23, "column": 20}}}, "severity": "ERROR"}
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"}
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.

> 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**.

#### Keep Segments in sync
After the first sync is done, Bitbucket Projects will continue to be insync 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.Spelling] Did you really mean 'insync'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'insync'?", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 34, "column": 70}}}, "severity": "ERROR"}


<br><br>
***
#### Check out what's new, and to come, in Codacy
Expand All @@ -33,4 +44,4 @@
height="472"
src="https://portal.productboard.com/2ng56ct2oir3adgbkvzfgqks" frameborder="0" >
</iframe>
</div>
</div>
Loading