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

Synchronization between ShowVoc projects and Git repository files #50

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

imbrou
Copy link
Collaborator

@imbrou imbrou commented Jan 21, 2025

Context

The goal of this PR is to simplify the management of ontologies and taxonomies by automating synchronisation between ShowVoc and Git.

Description

This pull request introduces a GitHub workflow to synchronize ShowVoc projects with RDF files of this repository.

Key choices

  • Synchronization between a list of ShowVoc projects and a list of remote file URLs.
  • Triggers on push to main.
  • Synchronization is configured in: .github/workflows/scripts/sync-config.json.
  • Single support for RDF/XML format.

Tests performed

The configuration in this PR has been tested in this CI run. It synchronises a test ShowVoc project with the Facets taxonomy file from the main branch of this repo.

Note: to open the ShowVoc link provided and see the TestSync project, you must be logged in with an admin account. TestSync is a "staging" project, which does not appear neither to visitors, nor to non-admin users.

Next steps

@imbrou imbrou self-assigned this Jan 21, 2025
@imbrou imbrou force-pushed the feature/cd-to-showvoc branch 6 times, most recently from e443d9d to 5ed33a4 Compare January 21, 2025 08:25
@imbrou imbrou changed the title Synchronization between ShowVoc projects and Git repository files (Draft) Synchronization between ShowVoc projects and Git repository files Jan 21, 2025
@imbrou imbrou force-pushed the feature/cd-to-showvoc branch 3 times, most recently from 84ac987 to 83f4306 Compare January 24, 2025 10:10
@imbrou imbrou marked this pull request as ready for review January 24, 2025 14:47
@imbrou imbrou changed the title (Draft) Synchronization between ShowVoc projects and Git repository files Synchronization between ShowVoc projects and Git repository files Jan 24, 2025
@imbrou imbrou force-pushed the feature/cd-to-showvoc branch 2 times, most recently from 4f052f5 to bfdb24b Compare January 26, 2025 18:22
@imbrou imbrou force-pushed the feature/cd-to-showvoc branch from bfdb24b to 833e573 Compare January 26, 2025 18:34
@imbrou
Copy link
Collaborator Author

imbrou commented Jan 26, 2025

I just committed the configuration to enable sync of all projects.

⚠️ Merging this PR will instantly synchronize according to the configuration in .github/workflows/scripts/sync-config.json.

I also refactored and linted my code with shellcheck.

Copy link

@RaggedStaff RaggedStaff left a comment

Choose a reason for hiding this comment

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

Mostly looks good @imbrou, thanks for your swift work on this!

I'm a little confused, as it looks like the config file is sourcing from the nextTaxononmies branch. I think we want ShowVOC to reflect the published content (which is on main). 😕

{
"project_name": "Facets",
"base_uri": "https://github.com/datafoodconsortium/taxonomies/releases/latest/download/facets.rdf#",
"source_url": "https://raw.githubusercontent.com/datafoodconsortium/taxonomies/refs/heads/nextTaxonomies/facets.rdf"

Choose a reason for hiding this comment

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

Is this coming from nextTaxonomies branch? I thought we'd agreed ShowVOC would sync with main ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Well spotted: my bad! It was a mistake in the config. I have just pushed a fix.

I tested the sync locally between the (staging) TestSync project and facets.rdf from the main branch and I think it works.

You can see the data in ShowVoc. You must login with admin privileges to see the TestSync project.

@imbrou imbrou linked an issue Jan 30, 2025 that may be closed by this pull request
@imbrou imbrou force-pushed the feature/cd-to-showvoc branch from 833e573 to 7574e24 Compare January 30, 2025 08:22
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

Successfully merging this pull request may close these issues.

Synchronize VocBench and ShowVoc together
2 participants