CI: Transition from s4ext to json #2011
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jcfr
force-pushed
the
transition-from-s4ext-to-json
branch
2 times, most recently
from
930b93b
to
edfaab2
Compare
|
For reference, the following script was used to convert from import json
import sys
from pathlib import Path
extensions_index_dir = Path("/home/jcfr/Projects/ExtensionsIndex")
updated_extensions_index_dir = extensions_index_dir
def parse_s4ext(ext_file_path):
"""Parse a Slicer extension description file.
:param ext_file_path: Path to a Slicer extension description file.
"""
ext_metadata = {}
with open(ext_file_path) as ext_file:
for line in ext_file:
if not line.strip() or line.startswith("#"):
continue
fields = [field.strip() for field in line.split(' ', 1)]
assert(len(fields) <= 2)
ext_metadata[fields[0]] = fields[1] if len(fields) == 2 else None
return ext_metadata
# Collect s4ext files
s4ext_filepaths = list(extensions_index_dir.glob("*.s4ext"))
print(f"Found {len(s4ext_filepaths)} extension files (.s4ext)")
# Parse s4ext files and generate corresponding json files
for index, filepath in enumerate(s4ext_filepaths):
metadata = parse_s4ext(filepath)
#print("filepath", filepath)
updated_metadata = {
"scmurl": metadata["scmurl"],
"scmrevision": metadata["scmrevision"],
"build_dependencies": [] if metadata.get("depends", "NA") == "NA" else metadata["depends"].split(" "),
"category": metadata["category"],
"build_subdirectory": metadata["build_subdirectory"],
}
with open(updated_extensions_index_dir / f"{filepath.stem}.json", 'w') as fileContents:
fileContents.write(json.dumps(updated_metadata, sort_keys=True, indent=2))
fileContents.write("\n")
print(f"Generated {index + 1} extension files (.json)")
from pprint import pprint as pp
print(f"\nMetadata of extension #{index + 1} ({filepath.stem}):\n")
pp(updated_metadata) |
jcfr
force-pushed
the
transition-from-s4ext-to-json
branch
from
edfaab2
to
52b8a82
Compare
20 tasks
This was referenced Mar 19, 2024
jcfr
force-pushed
the
transition-from-s4ext-to-json
branch
from
52b8a82
to
2ff4f6c
Compare
|
@lassoan This is ready for review |
jcfr
commented
Mar 19, 2024
lassoan
reviewed
Mar 20, 2024
This was referenced Apr 1, 2024
jcfr
force-pushed
the
transition-from-s4ext-to-json
branch
3 times, most recently
from
b0679b9
to
b3566f6
Compare
A script like the following was used. Note that "pre-commit run -a" was
also executed to reformat the json files afterward.
```
import json
import sys
from pathlib import Path
extensions_index_dir = Path("/home/jcfr/Projects/ExtensionsIndex")
updated_extensions_index_dir = extensions_index_dir
def parse_s4ext(ext_file_path):
"""Parse a Slicer extension description file.
:param ext_file_path: Path to a Slicer extension description file.
"""
ext_metadata = {}
with open(ext_file_path) as ext_file:
for line in ext_file:
if not line.strip() or line.startswith("#"):
continue
fields = [field.strip() for field in line.split(' ', 1)]
assert(len(fields) <= 2)
ext_metadata[fields[0]] = fields[1] if len(fields) == 2 else None
return ext_metadata
s4ext_filepaths = list(extensions_index_dir.glob("*.s4ext"))
print(f"Found {len(s4ext_filepaths)} extension files (.s4ext)")
for index, filepath in enumerate(s4ext_filepaths):
metadata = parse_s4ext(filepath)
updated_metadata = {
"scm_url": metadata["scmurl"],
"scm_revision": metadata["scmrevision"],
"build_dependencies": [] if metadata.get("depends", "NA") == "NA" else metadata["depends"].split(" "),
"category": metadata["category"],
"build_subdirectory": metadata["build_subdirectory"],
}
with open(updated_extensions_index_dir / f"{filepath.stem}.json", 'w') as fileContents:
fileContents.write(json.dumps(updated_metadata, sort_keys=True, indent=2))
fileContents.write("\n")
print(f"Generated {index + 1} extension files (.json)")
from pprint import pprint as pp
print(f"\nMetadata of extension #{index + 1} ({filepath.stem}):\n")
pp(updated_metadata)
```
Update GitHub and CircleCI settings to check for json files. Update `check_description_files` CLI to parse json files: * Remove `parse_s4ext` and introduce `parse_json` function along with `ExtensionParseError` exception. * Update list of supported URL schemes. Only `https` and `git` are supported * Remove obsolete `check_scm_notlocal` check
jcfr
force-pushed
the
transition-from-s4ext-to-json
branch
3 times, most recently
from
6699277
to
8528901
Compare
A script like the following was used. Note that "pre-commit run -a" was
also executed to reformat the json files afterward.
```
import json
import sys
from pathlib import Path
extensions_index_dir = Path("/home/jcfr/Projects/ExtensionsIndex")
json_filepaths = list(extensions_index_dir.glob("*.json"))
print(f"Found {len(json_filepaths)} extension files (.json)")
for index, filepath in enumerate(json_filepaths):
with open(filepath) as fileContents:
metadata = json.load(fileContents)
metadata["$schema"] = "https://raw.githubusercontent.com/Slicer/Slicer/main/Schemas/slicer-extension-catalog-entry-schema-v1.0.0.json#"
with open(extensions_index_dir / filepath, 'w') as fileContents:
fileContents.write(json.dumps(metadata, sort_keys=True, indent=2))
fileContents.write("\n")
```
jcfr
force-pushed
the
transition-from-s4ext-to-json
branch
from
4928e97
to
2a00294
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In response to discussions during the Slicer developer hangout on March 12th, we have decided to revamp the organization of extension metadata in the extensions index, transitioning from the s4ext format to json.
Motivation:
CMakeLists.txtfrom the ones organized in this repository and used to drive the build of extensions.Related issues:
Related pull requests:
Next steps:
cc: @lassoan @sjh26 @RafaelPalomar @mauigna06 @pieper
Footnotes
The
EXTENSION_CATEGORYvariable currently set in theCMakeLists.txtwill likely be deprecated ↩This is described on the Slice Discourse forum: https://discourse.slicer.org/t/introduction-of-tiers-for-slicer-extensions/34870 ↩