-
Notifications
You must be signed in to change notification settings - Fork 45
Segments GitHub SRM PLUTO-1072 #2214
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.
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
Merged
Changes from all commits
Commits
Show all changes
45 commits
Select commit
Hold shift + click to select a range
160aea8
Segments filter in SRM page
RaquelHipolito 14ba52e
update text component
RaquelHipolito 45306f5
Update managing-security-and-risk.md
RaquelHipolito 72faa96
Update managing-security-and-risk.md
RaquelHipolito 54eeeaa
Add segments doc page
RaquelHipolito 6bd0429
Update managing-security-and-risk.md
RaquelHipolito dea9c0e
adding segments page
RaquelHipolito 44628e8
Segments page content add
RaquelHipolito 6834254
titles sizes
RaquelHipolito 85bc7c0
Update segments.md
RaquelHipolito f81d0db
Update segments.md
RaquelHipolito c00a9d1
Update segments.md
RaquelHipolito 9ba3d57
Update segments.md
RaquelHipolito 81fe269
Update segments.md
RaquelHipolito d060f41
Update mkdocs.yml
RaquelHipolito eee744f
Update segments.md
RaquelHipolito 48fa341
Update segments.md
RaquelHipolito 07ce28e
will not > won't
RaquelHipolito ca1ecd8
spelling correction
RaquelHipolito 2490923
Update segments.md
RaquelHipolito 4e855aa
Update segments.md
RaquelHipolito efc6673
Update segments.md
RaquelHipolito adcc820
Update managing-security-and-risk.md
RaquelHipolito 9d22055
Update managing-repositories.md
RaquelHipolito db3b680
Update segments.md
RaquelHipolito 6f85fdd
correcting segments.md link path
RaquelHipolito 58c010e
/organizations/
RaquelHipolito 28d5d22
Update managing-repositories.md
jorgebraz a3fc4b8
Update segments.md
RaquelHipolito 4628ecc
Update managing-repositories.md
RaquelHipolito 5dc340a
Update managing-security-and-risk.md
RaquelHipolito 5c3dd1d
Update segments.md
RaquelHipolito 61ae550
Update managing-security-and-risk.md
RaquelHipolito 92de4ba
Update managing-repositories.md
RaquelHipolito 1a28e96
testing local setup
RaquelHipolito d89cf43
adding and updating images for segments
RaquelHipolito 4e9eaa0
correcting images
RaquelHipolito 97f3259
crop image
RaquelHipolito 7ef19f7
images and caps
RaquelHipolito 6366f90
update wording
RaquelHipolito 1cc355b
addressing feedback: images
RaquelHipolito 4ead91c
testing page bracking
RaquelHipolito e2f2cd4
testing page breaking II
RaquelHipolito b52c322
final changes
RaquelHipolito 3b756cc
last try with roadmap
RaquelHipolito File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+132 KB
docs/organizations/images/security-risk-management-findings-segments.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
BIN
-2.31 KB
(98%)
docs/organizations/images/security-risk-management-findings.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
BIN
+68 KB
(180%)
docs/organizations/images/security-risk-management-overview.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 added
BIN
+152 KB
docs/organizations/images/security-risk-management-segments-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # 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) | ||
|
|
||
|
|
||
| ## Where can Segments be utilised? | ||
| - [Repository list](../managing-repositories/#provider-segments) | ||
| - [Security & Management Risk](../managing-security-and-risk/) | ||
|
|
||
| ## Enabling Segments {: id="enabling-segments"} | ||
| To enable Segments, an initial sync between your provider and Codacy needs to happen. Once completed, you can use Segments to better locate and organize repositories within Codacy. | ||
|  | ||
|  | ||
| <br><br> | ||
RaquelHipolito marked this conversation as resolved.
Show resolved
Hide resolved
RaquelHipolito marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ### 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. | ||
|
|
||
| > 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. | ||
|
|
||
| <br><br> | ||
RaquelHipolito marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| *** | ||
RaquelHipolito marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| #### Check out what's new, and to come, in Codacy | ||
| <div> | ||
| <iframe id="inlineRoadmap" | ||
| title="Codacy Roadmap" | ||
| width="100%" | ||
| height="472" | ||
| src="https://portal.productboard.com/2ng56ct2oir3adgbkvzfgqks" frameborder="0" > | ||
| </iframe> | ||
| </div> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.