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

Include JSON-LD specifications as git submodules #181

Open
anatoly-scherbakov opened this issue Oct 18, 2023 · 2 comments
Open

Include JSON-LD specifications as git submodules #181

anatoly-scherbakov opened this issue Oct 18, 2023 · 2 comments

Comments

@anatoly-scherbakov
Copy link
Contributor

anatoly-scherbakov commented Oct 18, 2023

Presently, README.rst asks to manually clone JSON-LD spec repositories from W3C repo. We could instead add them as submodules; that would simplify development.

@BigBlueHat
Copy link
Contributor

My one concern here is that git submodules need to be updated if/when the upstream repo changes as they're pinned to specific commit SHAs. It may be all that's needed is a simple python script to run the commit commands needed to pull the latest repos locally.

@anatoly-scherbakov
Copy link
Contributor Author

anatoly-scherbakov commented Nov 2, 2023

@BigBlueHat Indeed, periodically one has to update the submodules. I would argue this is a good thing, similar to how one has to explicitly update Python dependencies of a project: it makes the project more reliable, and the builds more stable.

Updating dependencies, including the specs, should be a conscious decision and a human should be in the loop to fix possible issues.

Otherwise, a test run for a completely unrelated change can throw a bunch of errors clearly unrelated to the change, and it will take time to realize that one of the specs (and which one?) has been meanwhile updated.

Plus this guarantees that everyone who clones the repo has exactly the same versions of specs attached to it, this helps tests reproducibility and comparability of all setups.

anatoly-scherbakov added a commit to iolanta-tech/pyld that referenced this issue Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants