diff --git a/.github/dependabot.yml b/.github/dependabot.yml index c0e9ab409..e74551c00 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,13 +1,11 @@ -# Dependabot on the default integration branch (`devel`). -# CIP-0008: switch target-branch to main after that rename -# (backlog 2026-10-24_cip0008-rename-default-main). +# Dependabot on the default integration branch (`main`). # Security updates already opened #1232; this config also covers # weekly version bumps for pip (Poetry) and GitHub Actions. version: 2 updates: - package-ecosystem: pip directory: / - target-branch: devel + target-branch: main schedule: interval: weekly open-pull-requests-limit: 10 @@ -15,7 +13,7 @@ updates: - dependencies - package-ecosystem: github-actions directory: / - target-branch: devel + target-branch: main schedule: interval: weekly open-pull-requests-limit: 5 diff --git a/.github/workflows/test-and-deploy.yml b/.github/workflows/test-and-deploy.yml index 82779dfce..2a755742a 100644 --- a/.github/workflows/test-and-deploy.yml +++ b/.github/workflows/test-and-deploy.yml @@ -6,7 +6,6 @@ on: push: branches: - main - - devel pull_request: release: types: [published] diff --git a/README.md b/README.md index 85c7399cb..3b59f5ef9 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ The Gaussian processes framework in Python. * GPy [homepage](http://sheffieldml.github.io/GPy/) * Tutorial [notebooks](http://nbviewer.ipython.org/github/SheffieldML/notebook/blob/master/GPy/index.ipynb) -* Multi-output / coregionalized regression notes: [`doc/source/tuto_coregionalized.rst`](doc/source/tuto_coregionalized.rst) (also on [Read the Docs](https://gpy.readthedocs.io/en/devel/tuto_coregionalized.html) after the next docs build) +* Multi-output / coregionalized regression notes: [`doc/source/tuto_coregionalized.rst`](doc/source/tuto_coregionalized.rst) (also on [Read the Docs](https://gpy.readthedocs.io/en/latest/tuto_coregionalized.html)) * Community Q&A: [GitHub Discussions](https://github.com/SheffieldML/GPy/discussions) -* Developer [documentation](http://gpy.readthedocs.io/) [documentation (devel branch)](https://gpy.readthedocs.io/en/devel/) +* Developer [documentation](https://gpy.readthedocs.io/en/latest/) * [![licence](https://img.shields.io/badge/licence-BSD-blue.svg)](http://opensource.org/licenses/BSD-3-Clause) [![Research software impact](http://depsy.org/api/package/pypi/GPy/badge.svg)](http://depsy.org/package/python/GPy) @@ -14,7 +14,7 @@ The Gaussian processes framework in Python. | Branch | GitHub Actions | Codecov | | --- | --- | --- | -| Default branch (`devel`; CIP-0008 renames to `main`) | [![gha-devel](https://github.com/SheffieldML/GPy/actions/workflows/test-and-deploy.yml/badge.svg?branch=devel)](https://github.com/SheffieldML/GPy/actions/workflows/test-and-deploy.yml?query=branch%3Adevel) | [![codecov-devel](https://codecov.io/gh/SheffieldML/GPy/branch/devel/graph/badge.svg)](https://codecov.io/gh/SheffieldML/GPy/branch/devel) | +| `main` | [![gha-main](https://github.com/SheffieldML/GPy/actions/workflows/test-and-deploy.yml/badge.svg?branch=main)](https://github.com/SheffieldML/GPy/actions/workflows/test-and-deploy.yml?query=branch%3Amain) | [![codecov-main](https://codecov.io/gh/SheffieldML/GPy/branch/main/graph/badge.svg)](https://codecov.io/gh/SheffieldML/GPy/branch/main) | ## What's new: @@ -39,7 +39,7 @@ For an in depth description of pull requests, please visit https://help.github.c 3. Make sure the [guidelines](#gl) are met. 4. Set up tests to test your code. We are using unittests in the testing subfolder of GPy. There is a good chance that there is already a framework set up to test your new model in model_tests.py or kernel in kernel_tests.py. have a look at the source and you might be able to just add your model (or kernel or others) as an additional test in the appropriate file. There is more frameworks for testing the other bits and pieces, just head over to the testing folder and have a look. - 5. Create a pull request against the **default branch** (`devel`; CIP-0008 renames this to `main`). + 5. Create a pull request against **`main`**. 6. The tests will be running on your pull request. In the comments section we will be able to discuss the changes and help you with any problems. Let us know if there are any in the comments, so we can help. 7. The pull request gets accepted and your awesome new feature will be in the next GPy release :) @@ -168,7 +168,7 @@ If you're having trouble installing GPy via `pip install gpy` here is a probable git clone https://github.com/SheffieldML/GPy.git cd GPy - git checkout devel # default branch; CIP-0008 renames this to main + git checkout main poetry install --with dev pytest . @@ -257,16 +257,15 @@ The HTML files are then stored in doc/build/html ### Merging to the default branch -Open a pull request against the default branch (`devel`; CIP-0008 renames it -to `main`). CI (`Test Python Lib`) runs tests and lint on the PR. Do not open -a `devel` → `deploy` PR: that branch is stale and is not part of publishing. +Open a pull request against **`main`**. CI (`Test Python Lib`) runs tests and +lint on the PR. The old `deploy` branch is stale and is not part of publishing. Bump the Poetry version in `pyproject.toml` / `GPy/__version__.py` when cutting a release, and add a CHANGELOG section. ### Deploying GPy (CIP-0008) -1. Merge the version bump to the default branch. +1. Merge the version bump to `main`. 2. On GitHub: **Releases → Draft a new release**. 3. Create tag `vX.Y.Z` on that commit (must match `poetry version -s`). 4. **Publish** the release (a draft does not upload). diff --git a/backlog/documentation/2026-10-24_cip0008-readme-releasing.md b/backlog/documentation/2026-10-24_cip0008-readme-releasing.md index fca722862..ec9079301 100644 --- a/backlog/documentation/2026-10-24_cip0008-readme-releasing.md +++ b/backlog/documentation/2026-10-24_cip0008-readme-releasing.md @@ -1,7 +1,7 @@ --- id: 2026-10-24_cip0008-readme-releasing title: CIP-0008 — README releasing instructions -status: In Progress +status: Completed priority: Medium created: "2026-10-24" last_updated: "2026-10-24" @@ -40,3 +40,7 @@ publish a GitHub Release `vX.Y.Z`, watch `Test Python Lib` deploy. ### 2026-10-24 Task created In Progress with the CI change. + +README releasing steps now say merge to `main` and publish a GitHub +Release. Contributor/clone/badge/RTD links follow the default-branch +rename. diff --git a/backlog/infrastructure/2026-10-24_cip0008-ci-main-release.md b/backlog/infrastructure/2026-10-24_cip0008-ci-main-release.md index 76459ffb7..f1003e9d1 100644 --- a/backlog/infrastructure/2026-10-24_cip0008-ci-main-release.md +++ b/backlog/infrastructure/2026-10-24_cip0008-ci-main-release.md @@ -1,7 +1,7 @@ --- id: 2026-10-24_cip0008-ci-main-release title: CIP-0008 CI — published-only release, wheel dry-run, drop deploy trigger -status: In Progress +status: Completed priority: High created: "2026-10-24" last_updated: "2026-10-24" @@ -56,3 +56,7 @@ Do not change Poetry/Cython build mechanics. Keep `twine` + `id-token` Task created In Progress. 1.15.0 is on PyPI (`requires_python >=3.9,<4`, aarch64 wheels present). + +Landed in [#1244](https://github.com/SheffieldML/GPy/pull/1244). Default +branch is now `main`; a `workflow_dispatch` dry-run was queued on that +branch. diff --git a/backlog/infrastructure/2026-10-24_cip0008-rename-default-main.md b/backlog/infrastructure/2026-10-24_cip0008-rename-default-main.md index 2d7e37c71..d08874122 100644 --- a/backlog/infrastructure/2026-10-24_cip0008-rename-default-main.md +++ b/backlog/infrastructure/2026-10-24_cip0008-rename-default-main.md @@ -1,7 +1,7 @@ --- id: 2026-10-24_cip0008-rename-default-main title: CIP-0008 — rename default branch devel to main -status: Ready +status: In Progress priority: High created: "2026-10-24" last_updated: "2026-10-24" @@ -32,11 +32,11 @@ delete the stale `deploy` branch (last commit July 2024). ## Acceptance Criteria -- [ ] Repository default branch is `main` -- [ ] Dependabot PRs open against `main` -- [ ] CI `push` triggers are `main` only (no `deploy`, no leftover `devel` +- [x] Repository default branch is `main` +- [x] Dependabot PRs open against `main` +- [x] CI `push` triggers are `main` only (no `deploy`, no leftover `devel` unless a redirect branch remains) -- [ ] README contributor/release instructions say `main` +- [x] README contributor/release instructions say `main` - [ ] `deploy` removed from CI; branch deleted or clearly archived ## Related @@ -50,3 +50,7 @@ delete the stale `deploy` branch (last commit July 2024). Task created Ready. Do this after the CI PR merges so `devel` still receives the workflow that knows about `main`. + +GitHub default branch renamed `devel` → `main`. Follow-up PR retargets +Dependabot, drops leftover `devel` from `push:`, and updates README/RTD +links. The stale `deploy` branch is left in place (not a CI trigger). diff --git a/cip/cip0008.md b/cip/cip0008.md index 52391c6f3..17537bfd2 100644 --- a/cip/cip0008.md +++ b/cip/cip0008.md @@ -168,7 +168,7 @@ CIP-0003 / #1209. - [x] 1.15.0 GitHub Release used the old path; open questions resolved; CIP Accepted - [x] v1.15.0 on PyPI (`pip install gpy==1.15.0`; aarch64 wheels included) - [x] CI: `types: [published]`, `workflow_dispatch` wheel dry-run, drop `deploy` trigger, tag == Poetry version -- [ ] Default branch renamed `devel` → `main`; Dependabot `target-branch: main` +- [x] Default branch renamed `devel` → `main`; Dependabot `target-branch: main` - [ ] First release on new pipeline verified; CIP Closed ## References