From bcc22cf68365fa66c6f0b47dc08afcffb7748be5 Mon Sep 17 00:00:00 2001 From: PGijsbers Date: Sat, 10 Oct 2026 18:07:54 +0200 Subject: [PATCH 1/3] Update references to the development branch to use main if applicable --- .github/workflows/dist.yaml | 2 -- .github/workflows/docs.yaml | 4 +--- .github/workflows/release_docker.yaml | 2 +- .github/workflows/test.yml | 2 -- CONTRIBUTING.md | 9 +-------- docker/readme.md | 10 +++++----- 6 files changed, 8 insertions(+), 21 deletions(-) diff --git a/.github/workflows/dist.yaml b/.github/workflows/dist.yaml index ecf6f0a7f..e29fa0739 100644 --- a/.github/workflows/dist.yaml +++ b/.github/workflows/dist.yaml @@ -6,14 +6,12 @@ on: push: branches: - main - - develop tags: - "v*.*.*" pull_request: branches: - main - - develop concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 1a5a36a87..e29fa6689 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -5,14 +5,12 @@ on: push: branches: - main - - develop tags: - "v*.*.*" pull_request: branches: - main - - develop concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} @@ -40,7 +38,7 @@ jobs: CI: false GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} PAGES_BRANCH: gh-pages - if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push' + if: contains(github.ref, 'main')) && github.event_name == 'push' run: | git config user.name doc-bot git config user.email doc-bot@openml.com diff --git a/.github/workflows/release_docker.yaml b/.github/workflows/release_docker.yaml index fcea357e4..c13257f34 100644 --- a/.github/workflows/release_docker.yaml +++ b/.github/workflows/release_docker.yaml @@ -4,7 +4,7 @@ on: workflow_dispatch: push: branches: - - 'develop' + - 'main' - 'docker' tags: - 'v*' diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 159de329f..33fdbbe44 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -7,14 +7,12 @@ on: push: branches: - main - - develop tags: - "v*.*.*" pull_request: branches: - main - - develop concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38b13825b..5038cb355 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -153,8 +153,7 @@ in the PR description. The preferred workflow for contributing to openml-python is to fork the [main repository](https://github.com/openml/openml-python) on -GitHub, clone, check out the branch `main`, and develop on a new branch -branch. Steps: +GitHub, clone, and develop on a new branch: 0. Make sure you have git installed, and a GitHub account. @@ -171,12 +170,6 @@ local disk: cd openml-python ``` -3. Switch to the ``develop`` branch: - - ```bash - git checkout main - ``` - 3. Create a ``feature`` branch to hold your development changes: ```bash diff --git a/docker/readme.md b/docker/readme.md index d0af9d9fe..ef9653954 100644 --- a/docker/readme.md +++ b/docker/readme.md @@ -44,10 +44,10 @@ docker run -v PATH/TO/FILE:/openml/MY_SCRIPT.py openml/openml-python MY_SCRIPT.p You can run the unit tests by passing `test` as the first argument. It also requires a local or remote repository to be specified, which is explained [below]((#using-local-or-remote-code). For this example, we specify to test the -`develop` branch: +`my-feature` branch: ```text -docker run openml/openml-python test develop +docker run openml/openml-python test my-feature ``` ### Building documentation @@ -56,16 +56,16 @@ You can build the documentation by passing `doc` as the first argument, you should [mount]((https://docs.docker.com/storage/bind-mounts/#start-a-container-with-a-bind-mount)) an output directory in which the docs will be stored. You also need to provide a remote or local repository as explained in [the section below]((#using-local-or-remote-code). -In this example, we build documentation for the `develop` branch. +In this example, we build documentation for the `my-feature` branch. On Windows: ```text - docker run --mount type=bind,source="E:\\files/output",destination="/output" openml/openml-python doc develop + docker run --mount type=bind,source="E:\\files/output",destination="/output" openml/openml-python doc my-feature ``` on Linux: ```text - docker run --mount type=bind,source="./output",destination="/output" openml/openml-python doc develop + docker run --mount type=bind,source="./output",destination="/output" openml/openml-python doc my-feature ``` see [the section below]((#using-local-or-remote-code) for running against local changes From a92c7a961e0f969dfbf7da103f61b95301ce948c Mon Sep 17 00:00:00 2001 From: PGijsbers Date: Sat, 10 Oct 2026 18:13:51 +0200 Subject: [PATCH 2/3] Fix typo --- .github/workflows/docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index e29fa6689..b976cf463 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -38,7 +38,7 @@ jobs: CI: false GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} PAGES_BRANCH: gh-pages - if: contains(github.ref, 'main')) && github.event_name == 'push' + if: contains(github.ref, 'main') && github.event_name == 'push' run: | git config user.name doc-bot git config user.email doc-bot@openml.com From 03fb03808e292d00295959d6b1b8f181b7c03071 Mon Sep 17 00:00:00 2001 From: PGijsbers Date: Sat, 10 Oct 2026 18:23:41 +0200 Subject: [PATCH 3/3] Fix pymdown extension --- pyproject.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 8c463968b..cdda48eff 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -105,7 +105,8 @@ docs=[ "mkdocs-section-index", "mkdocs-jupyter", "mkdocs-linkcheck", - "mike" + "mike", + "pymdown-extensions<12.2", # 2026-10-10: incompatibility of 12.2 with mkdocstrings ] [project.urls]