Hi all,

Plugin labels are displayed on the plugin site (e.g. see
https://plugins.jenkins.io/git/) and can be used for the plugin
search: (github-related
plugins <https://plugins.jenkins.io/ui/search/?labels=github> or kubernetes
<https://plugins.jenkins.io/ui/search/?labels=kubernetes>). So setting
labels can help to make your plugins more discoverable for users. Later we
ccould also use labels to highlight plugins in the plugin site (e.g. tag
cloud <https://github.com/jenkins-infra/plugin-site/issues/137>), Jenkins
plugin manager and the installation wizard.

We used to manage labels from Wiki, and then switched to the label
definitions file
<https://github.com/jenkins-infra/update-center2/blob/master/src/main/resources/label-definitions.properties>
in the Update Center repository. Both approaches were quite difficult to
manage, and usage of labels in Jenkins was quite low. Many top-installed
plugins did not have labels at all. Thanks to the work by Gavin Mogan,
Jenkins update center now supports retrieving plugin labels from GitHub
topics.So any maintainer can now easily manage labels via GitHub, and they
will be synchronized to the plugin site.

*Example:*
[image: image.png]

*How to set up topics for your plugins?*

   - Go to your plugin repository, click the "Manage topics" link. You
   should have Manage/Administer permissions to do so, but this is what we
   grant to maintainer teams by default
   - Set relevant GitHub topics
      - GitHub suggests some topics based on the repo name, summary and the
      technologies used
      - You can create your own topics if needed
   - Check out the labels whitelist in
   /jenkins-infra/update-center2.../allowed-labels.properties
   
<https://github.com/jenkins-infra/update-center2/blob/master/src/main/resources/allowed-labels.properties>
   ,
      - You can suggest new labels using pull requests if needed
      - "jenkins-" prefix in GitHub topics is automatically truncated

*Best known practices*
Right now we do not have documentation about labeling best practices. I
believe we can figure it out as we go, Documentation SIG channels could be
used for such topics. E.g. see this initial discussion
<https://github.com/jenkins-infra/update-center2/pull/348#discussion_r384591835>
with Mark Waite.

Best regards,
Oleg Nenashev

-- 
You received this message because you are subscribed to the Google Groups 
"Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to jenkinsci-dev+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/jenkinsci-dev/CAPfivLC5SBVZcUM1RSC%3DJEQB9LXMhjaRgXk51x%2B%3D1PYv_LvZpQ%40mail.gmail.com.

Reply via email to