Skip to content

Add user documentation about the new avatar trait. #990

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 1 commit into from
Feb 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 20 additions & 1 deletion docs/USER_GUIDE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,25 @@ project is created for each repository.
+
image::images/screenshot-9.png[scaledwidth=90%]

[id=bitbucket-avatar]
== Avatar

This plugin have customized icon designed for the "Organization Folder" image:/src/main/webapp/images/bitbucket-logo.svg[icon,20,20], for "Multibranch Pipeline", for Single Repository image:/src/main/webapp/images/bitbucket-repository-git.svg[icon,20,20] and Folder image:/src/main/webapp/images/bitbucket-scmnavigator.svg[icon,20,20] project type. This is the default behaviour of the plugin starting from version 935.
It is possible associate the Bitbucket avatar to the project item selecting the "Show Bitbucket avatar images" behaviour in the project configuration.
+
image::images/screenshot-19.png[scaledwidth=90%]

The supported avatars are:

* Organization Folder:
** Cloud: workspace avatar
** Data Center: project avatar
* Multibranch Repository:
** Cloud: repository avatar
** Data Center: does not support customization of the repository avatar

The default Bitbucket avatar is a generated SVG image, since this plugin does not support SVG format, this image will be replaced by a Jenkins random generated image.

[id=bitbucket-webhooks]
== Webhooks registering

Expand All @@ -105,7 +124,7 @@ image::images/screenshot-14.png[scaledwidth=90%]
For both Bitbucket _Multibranch Pipelines_ and _Organization folders_ there is an "Override hook management" behavior
to opt out or adjust system-wide settings.

image::images/screenshot-4.png[scaledwidth=90%]
image::images/screenshot-18.png[scaledwidth=90%]

IMPORTANT: In order to have the auto-registering process working fine the Jenkins base URL must be
properly configured in _Manage Jenkins_ » _System_
Expand Down
Binary file modified docs/images/screenshot-1.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 docs/images/screenshot-18.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 docs/images/screenshot-19.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/images/screenshot-2.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/images/screenshot-4.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/images/screenshot-8.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/images/screenshot-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@
@JsonProperty("name")
private String displayName;

private String avatar;

@JsonProperty("links")
@JsonDeserialize(keyAs = String.class, contentUsing = BitbucketHref.Deserializer.class)
private Map<String,List<BitbucketHref>> links;
Expand All @@ -61,6 +59,6 @@

@Override
public String getAvatar() {
return avatar == null ? getLink("self") + "/avatar.png" : avatar;
return getLink("self") + "/avatar.png";

Check warning on line 62 in src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/repository/BitbucketServerProject.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered line

Line 62 is not covered by tests
}
}
Loading