Iss #112 - Add help message related to common troubleshooting to ui

Resolves #112 (closed)

assigned to @cguindon, @zacharysabourin, and @oliviergoulet

Examples of how this new content looks:

I wonder if we should styles the tips section the same we are doing on drupal: https://accounts.eclipse.org/legal/eca/validation/126686

Also, I am noticing that we include an Eclipse Intellectual Property Management info-bubble if the changes is bigger than 1000 lines of code.

How hard would that be to implement?

I wonder if we should styles the tips section the same we are doing on drupal: https://accounts.eclipse.org/legal/eca/validation/126686

This is what that would look like (really quick mock up so not exact):

Also, I am noticing that we include an Eclipse Intellectual Property Management info-bubble if the changes is bigger than 1000 lines of code. How hard would that be to implement?

Pretty damn complicated, since there is no standard way to check the number of LOC changed, and we don't store the PR number or request it.

As an example, the closest we could get in Gitlab is this call: https://gitlab.eclipse.org/api/v4/projects/1090/merge_requests/122/changes. Changes count is the number of files, and the LOC count is buried inside a field that looks like @@ -57,7 +57,7 ...the raw diff string. There is nowhere in the request where the LOC is tabulated easily.

Github is a little cleaner, with this API spec for list of commit changes for PR having actual numbers https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests-files, but if the same lines are added and removed, they will count twice per line for no functional changes in the API from what I can tell.

I'm open to a solution to this, but counting LOC doesn't look promising

requested review from @oliviergoulet, @zacharysabourin, @epoirier, and @cguindon

unassigned @cguindon, @zacharysabourin, and @oliviergoulet

Pretty damn complicated, since there is no standard way to check the number of LOC changed, and we don't store the PR number or request it.

We need to ensure that this is included with validations from GH. The logic that we use on drupal is simply printing that info-bubble if the additions property value equals or is bigger than 1000: https://api.github.com/repos/eclipse/openvsx/pulls/596

As an example, the closest we could get in Gitlab is this call: https://gitlab.eclipse.org/api/v4/projects/1090/merge_requests/122/changes. Changes count is the number of files, and the LOC count is buried inside a field that looks like @@ -57,7 +57,7 ...the raw diff string. There is nowhere in the request where the LOC is tabulated easily.

Could we calculate the line change count via the git hook and pass that information to the API?

https://stackoverflow.com/questions/9933325/is-there-a-way-of-having-git-show-lines-added-lines-changed-and-lines-removed

EXAMPLE: git diff --numstat 3f498d3ff0766590c0c0436dd944a6cb48602267 cf8da7952e5a7f2d4f33d87febc030fcf91c8306

mentioned in issue #114 (closed)

@cguindon I've created a new issue to track this feature #114 (closed). This way this change set can be approved and merged without impacting that change set, which may take a couple of days.

Great, thanks!

changed target branch from master to main

added 1 commit

• 6b491d82 - Update style of help window to use panel instead of alert

Compare with previous version

Ready for review, updated to be panel instead of alert to be consistent.

approved this merge request

merged

mentioned in commit 78903447