Skip to content
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

Update check_description_files script and fix s4ext files #2029

Merged

Conversation

jcfr
Copy link
Member

@jcfr jcfr commented Apr 4, 2024

Before moving forward with the transition from .s4ext to .json, we are following these steps:

  1. Fix the extension metadata in the .s4ext files
  2. Update the CMakeLists.txt in each extension GitHub repository with the correct values

This pull request corresponds to the first step.

Remaining updates for step 1:

  • Add missing metadata
  • Update homepage URL to use https
  • Update iconurl URL to use https
  • Update screenshoturls to use https
  • Update check_description_files to check URLs are reachable
  • Fix URLs
  • Update CircleCI config to run check with --check-urls-reachable

Related pull requests:

@jcfr jcfr marked this pull request as draft April 4, 2024 06:35
@jcfr jcfr force-pushed the tweak-check_description_files-script-and-fix-s4ext-files branch from cce9fcd to 873fadd Compare April 4, 2024 12:54
jcfr added 16 commits April 4, 2024 13:09
Add missing metadata keys: contributors, description, homepage, iconurl, screenshoturls

Update invalid homepage value

Remove extra spaces in screenshoturls list
Use direct link to the corresponding image instead of link of the form
`http://www.slicer.org/wiki/File:ImageName.png`.

Use `https://www.slicer.org/slicerWiki/images` URL base instead of invalid
`http://www.slicer.org/w/images`.

Use `https://www.na-mic.org/w/img_auth.php` URL base instead of invalid
`http://wiki.na-mic.org/Wiki/images`.
@jcfr jcfr force-pushed the tweak-check_description_files-script-and-fix-s4ext-files branch from 8c9960e to 91560e6 Compare April 4, 2024 19:44
@jcfr jcfr force-pushed the tweak-check_description_files-script-and-fix-s4ext-files branch from 91560e6 to 0ccd10e Compare April 4, 2024 22:35
jcfr added 4 commits April 4, 2024 19:53
* Fix use of GitHub raw links for screenshoturls associated with these extensions:
  - iGyne
  - mpReview
  - SurfaceWrapSolidify

* SNRMeasurement: Switch to using existing URL instead of placeholder one

* RegistrationQA: Switch to using screenshot from repository instead of
  placeholder URL.

* SlicerOpenAnatomy: Use updated URLs to account for extension re-organization
  See PerkLab/SlicerOpenAnatomy@7bab080f7

* CarreraSlice: Fix URL prefix using `www.na-mic.org/w/img_auth.php` instead
  of unsupported `www.na-mic.org/Wiki/images/thumb`

* OpenDose3D: Update URLs to account for rename from `Dosimetry4D` to `OpenDose3D`
* SlicerZFrameRegistration: Use https://github.com/SlicerProstate/SlicerZFrameRegistration
  instead of non-existent https://slicer.org/slicerWiki/index.php/Documentation/Nightly/Extensions/ZFrameRegistration

* Switch to using link to README instead of non-existent Slicer wiki page:
  - ResectionPlanner
  - SlicerSkinMouldGenerator
  - SNRMeasurement

* PETCPhantom: Switch to using existing wiki page associated with PETCPhantomAnalysis
  module.
Considering maintainers have been unresponsive[^1], switch to using @jamesobutler
fork.

[^1]: AldrickF/SlicerRegularizedFastMarching#2
jcfr added 4 commits April 4, 2024 20:40
Regression liked introduced
in pieper/SlicerParallelProcessing@7e8401d90 (Rename extension from SlicerProcesses to ParallelProcessing)
This is expected to address the following:

```
$ python ./scripts/check_description_files.py \
  --check-urls-reachable \
  AstmPhantomTest.s4ext SlicerIGT.s4ext
[...]
AstmPhantomTest.s4ext
  homepage is 'https://www.atracsys-measurement.com/astm/': The read operation timed out
SlicerIGT.s4ext
  homepage is 'https://www.slicerigt.org': The read operation timed out
Checked content of 2 description files.
Total errors found in extension descriptions: 2
```
@jcfr jcfr force-pushed the tweak-check_description_files-script-and-fix-s4ext-files branch from acb9fc5 to bd8f866 Compare April 5, 2024 01:27
…pository-name

Following 553c045 ("CI: Update check_git_repository_name hard-coding
exceptions", 2024-03-12), exceptions are hard-coded and there is no need
to run the check only for new files.
@jcfr jcfr force-pushed the tweak-check_description_files-script-and-fix-s4ext-files branch from bd8f866 to d7e8ea5 Compare April 5, 2024 01:33
@jcfr jcfr force-pushed the tweak-check_description_files-script-and-fix-s4ext-files branch from a990fe1 to 67c5205 Compare April 5, 2024 01:35
@jcfr jcfr marked this pull request as ready for review April 5, 2024 01:38
Copy link
Contributor

@jamesobutler jamesobutler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏻

@jcfr jcfr merged commit e2aa752 into Slicer:main Apr 11, 2024
3 checks passed
@jcfr jcfr deleted the tweak-check_description_files-script-and-fix-s4ext-files branch April 11, 2024 19:48
@jcfr jcfr linked an issue Apr 24, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Extensions with invalid homepage, iconurl and screenshots metadata
2 participants