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

Set up infrastructure for qiskit-tutorials migration #10443

Merged
merged 4 commits into from
Aug 9, 2023

Commits on Aug 7, 2023

  1. Add infrastructure for building tutorials

    This first commit is a rebase of Eric's initial PR as of db1ce62 onto
    `main`, fixing up some changes caused by the CI infrastructure changing
    a bit since the PR was first opened.
    
    Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
    Eric-Arellano and jakelishman committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    8c4ef73 View commit details
    Browse the repository at this point in the history
  2. Harden tutorials Azure job

    This moves much of the fetch- and process-related code into separate
    scripts that assert far more about the directory structure, and fail if
    they do not match the assumptions.  We don't want to accidentally get
    out-of-sync while we're changing things and end up with a tutorials job
    that isn't really doing its job without us noticing.
    
    The tutorials-fetching script can now also be re-used in a separate
    GitHub Actions workflow that will handle the full tutorials-included
    documentation build and deployment in the future.
    
    The notebook-convertion step is moved into Python space, using
    `nbconvert` as a library in order to parallelise the build process for
    the tutorials, and to allow CI and developers calling `tox` directly to
    specify the output directories for the built tutorials.
    jakelishman committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    5ababc0 View commit details
    Browse the repository at this point in the history
  3. Retarget tutorial-conversion utility as executor

    This reorganises the tutorial "conversion" utility to make it clearer
    that what it's actually doing is just executing the tutorials.  The
    script itself is changed to default to editing the files inplace, while
    the `tox` job is updated to write the files into a special directory,
    making it easier to clean up a dirty build directory and making it so
    subsequent local executions will not pick up the converted files.
    jakelishman committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    3e4ad57 View commit details
    Browse the repository at this point in the history

Commits on Aug 9, 2023

  1. Allow configuration of tutorials execution

    There was a worry that not being able to configure these would make it
    more unpleasant to use `tox` for the jobs locally.
    jakelishman committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    6e3f4ff View commit details
    Browse the repository at this point in the history