Skip to content

TCK files script in its own directory #565

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Conversation

romaintailhurat
Copy link
Collaborator

I didn't yet add parameters for version directory, it's only working for v2.1 but it's a very quick fix to support that if we want.

@NicoLaval NicoLaval marked this pull request as draft April 14, 2025 07:11
@NicoLaval
Copy link
Collaborator

@linardian @amattioc, GitHub Pages via deploy-pages only allows one workflow at a time to deploy.
We have to switch to gh-pages deployment to handle properly docs & tck.

GitHub Pages setup:

In your repository settings, go to Settings > Pages, and configure:

  • Source: Deploy from a branch
  • Branch: gh-pages
  • Folder: / (root)

Workflow behavior:

build-docs.yml

  • Runs on push or PR to master
  • Builds the documentation (HTML and PDF) from:
    • docs/ (main)
    • v2.1/docs/ (versioned)
  • Publishes to gh-pages/2.1/html/

generate-tck.yml

  • Runs when files under v*/docs/reference_manual/operators/ change
  • Generates TCK files for each version (only v2.1 for now, but ready for next versions)
  • Publishes to gh-pages/tck/{version}/

Safe deployment:

  • Both workflows check out the gh-pages branch
  • They only update their own folders (2.1/html/ or tck/vX.Y/)
  • A git pull --rebase is done before pushing to avoid overwriting changes from the other workflow

@javihern98 @vpinna80 @hadrienk @romaintailhurat, please review to confirm operation.

@NicoLaval NicoLaval marked this pull request as ready for review April 14, 2025 08:38
@vpinna80
Copy link
Collaborator

@NicoLaval Can you remove the subfolders ex1, ex2, etc.?

Also the idea was to have only a single json file for each operator, or at least one for each example, describing all the datasets, the structures, the variables and the domains (for those operators like check_hierarchy).

Before we go on with this pull request, I would like to have a finalized json schema to avoid redoing the same job over and over again.

@NicoLaval
Copy link
Collaborator

Hi @vpinna80,

I proposed a json to initialize common work about TCK.
But as @antonio-olleros already has something nice, I think it's a good way to start. It fits very well for us.

If it's not good for you, I cancel the GHA part for now, while keeping the python script, and we discuss later (I'm taking a few days off starting today) together to find something that suits us all.

@linardian linardian deleted the branch master April 15, 2025 12:37
@linardian linardian closed this Apr 15, 2025
@linardian linardian reopened this Apr 15, 2025
@vpinna80 vpinna80 changed the base branch from develop to master April 16, 2025 07:00
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.

5 participants