Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
# 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
labels:
- dependencies
- package-ecosystem: github-actions
directory: /
target-branch: devel
target-branch: main
schedule:
interval: weekly
open-pull-requests-limit: 5
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/test-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
push:
branches:
- main
- devel
pull_request:
release:
types: [published]
Expand Down
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ 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)

## Status

| 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:

Expand All @@ -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 :)

Expand Down Expand Up @@ -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 .

Expand Down Expand Up @@ -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).
Expand Down
6 changes: 5 additions & 1 deletion backlog/documentation/2026-10-24_cip0008-readme-releasing.md
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -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.
6 changes: 5 additions & 1 deletion backlog/infrastructure/2026-10-24_cip0008-ci-main-release.md
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -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.
14 changes: 9 additions & 5 deletions backlog/infrastructure/2026-10-24_cip0008-rename-default-main.md
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -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
Expand All @@ -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).
2 changes: 1 addition & 1 deletion cip/cip0008.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading