Github documentation not appearing on plugins.jenkins.io

[l3ender]

Service(s)

plugins.jenkins.io

Summary

The repo for github-scm-trait-notification-context-plugin has been updated so that documentation will be served from Github (followed doc), but the plugin's page is still showing old/wiki content.

Please let me know if I missed anything in the repository. Thank you!

Reproduction steps

1. Go to https://github.com/jenkinsci/github-scm-trait-notification-context-plugin and observe readme/pom.xml settings for documentation.
2. Go to https://plugins.jenkins.io/github-scm-trait-notification-context/ and observe content does not match Github readme.

[l3ender]

I should also note that the plugin health page for the plugin doesn't appear to match what is configured in the repo: https://plugin-health.jenkins.io/scores/github-scm-trait-notification-context.

[lemeurherve]

Ping @alecharp for the plugin health score part.

[MarkEWaite]

I wonder if the GitHub API requests that are being used to generate that data are somehow behaving differently because the official repository https://github.com/jenkinsci/github-scm-trait-notification-context-plugin has not been unforked from the original repository https://github.com/steven-foster/github-scm-trait-notification-context

We recommend that the official repository https://github.com/jenkinsci/github-scm-trait-notification-context-plugin should not be a fork of any repository. You can follow guide comments in https://stackoverflow.com/questions/38831301/how-to-un-fork-the-github-repository that leads to https://stackoverflow.com/questions/38831301/how-to-un-fork-the-github-repository/66470086#66470086 . That may not resolve the issue, but it will make your life easier later.

[l3ender]

Update: the plugin repo was detached/extracted from its original repo around 9p on 2023-10-01. As of now (~12 hours later), I'm still seeing outdated content on plugins.jenkins.io and plugin-health.jenkins.io.

[MarkEWaite]

I'm perplexed to the point where I don't have an explanation why plugins.jenkins.io is not seeing the documentation URL that is included in the most recently released pom file of the plugin. I've compared that plugin pom file to the most pom file of the most recent release of the git plugin and did not see any significant surprises.

Both plugins list the url property correctly as the repository URL. The git plugin lists it as:

<url>https://github.com/jenkinsci/git-plugin</url>

The github-scm-trait-notification-context plugin lists it as:

<url>https://github.com/jenkinsci/github-scm-trait-notification-context-plugin</url>

I recall that there were length limits in some portion of the infrastructure, but I don't remember the details. I'll see if this can be discussed in the infra team meeting tomorrow in case others have an idea why the release is visible on plugins.jenkins.io but the documentation for the release is still listed as sourced from the wiki.

[timja]

Plugin site API is correctly pointing to GitHub:
https://plugins.jenkins.io/api/plugin/github-scm-trait-notification-context

Build logs for the site have:

[2023-10-03T03:17:01.950Z] ➤ YN0000: [@jenkins-cd/jenkins-plugin-site]: success Fetching 'https://raw.githubusercontent.com/jenkins-infra/plugins-wiki-docs/master/github-scm-trait-notification-context/README.md' - 1.836s

which seems fine

[timja]

@halkeye any idea?

[halkeye]

Ideas about?

matches https://raw.githubusercontent.com/jenkins-infra/plugins-wiki-docs/master/github-scm-trait-notification-context/README.md to me

[halkeye]

or are you asking why its renderig the wiki content?

https://github.com/jenkins-infra/update-center2/blob/77bcef2630467ba31f4bcabdec74421f2ca629e3/resources/wiki-overrides.properties#L58

[halkeye]

https://github.com/jenkins-infra/plugin-site/blob/5429a8de21b8bea26dd84a293f624909b1cbcb1c/plugins/gatsby-source-jenkinsplugins/utils.mjs#L210C1-L210C102

it uses https://updates.jenkins.io/current/plugin-documentation-urls.json for the data

overrides suck

[lemeurherve]

Thanks @halkeye for these pointers, taking a look at it.

@timja last plugin-site build failed with error error trying to fetch https://plugins.jenkins.io/api/plugin/ecu-test-execution Request failed with status code 503, the four previous one which ran from yesterday to this morning were OK, started a new one.

[lemeurherve]

Opened jenkins-infra/update-center2#742

[lemeurherve]

@l3ender the plugin page is now correctly displaying the GitHub README content:

Again many thanks @halkeye for the links! 🙌

[lemeurherve]

I should also note that the plugin health page for the plugin doesn't appear to match what is configured in the repo: https://plugin-health.jenkins.io/scores/github-scm-trait-notification-context.

@l3ender would you mind detailing what's wrong with the plugin health page in a distinct help desk issue?

Closing this one.