|
| 1 | +# CI documentation |
| 2 | + |
| 3 | +TileDB-Py currently uses two CI services: |
| 4 | + - GitHub actions for routine CI |
| 5 | + - Azure Pipelines for release packaging |
| 6 | + |
| 7 | +## GitHub Actions |
| 8 | + |
| 9 | +<TODO> |
| 10 | + |
| 11 | +### Nightly Builds |
| 12 | + |
| 13 | +- <triggering setup> |
| 14 | + |
| 15 | +## Azure Pipelines |
| 16 | + |
| 17 | +AZP is configured in [azure-pipelines.yml](), which points to two pipeline files in `misc`: |
| 18 | + - [misc/azure-ci.yml](): Legacy CI, to ensure that the release build continue to work. |
| 19 | + - [misc/azure-release.yml](): release build system, which creates Python wheels for PyPI distribution. |
| 20 | + |
| 21 | + |
| 22 | +### Release builds |
| 23 | + |
| 24 | +AZP release builds |
| 25 | + |
| 26 | +### Service Connection |
| 27 | + |
| 28 | +In order to create issues after nightly build failure, the AZP nightly pipeline uses a service connection |
| 29 | +with authorization to post to GitHub. |
| 30 | + - Configuration page: [https://dev.azure.com/TileDB-Inc/CI/_settings/adminservices](https://dev.azure.com/TileDB-Inc/CI/_settings/adminservices) |
| 31 | + - Connection name: `TileDB-Py-Test` |
| 32 | + - Setup, from services configuration page above: |
| 33 | + - Create a new Personal Access token |
| 34 | + - At present, the repo dispatch token must be linked to an individual user account. |
| 35 | + - Visit: https://github.com/settings/tokens/new |
| 36 | + - Create token with `public_repo` scope and 1 year expiration (maximum) |
| 37 | + - Visit configuration page linked above |
| 38 | + - Select `New Service Connection` |
| 39 | + - Select `Generic` |
| 40 | + - Server URL: `https://api.github.com/` |
| 41 | + - Password/token: <GitHub personal access token created above> |
| 42 | + - Disable access to all repositories (will require pipeline-specific authorization on first pipeline execution) |
| 43 | + - Save the new connection. Note that the connection name must match the name specified for |
| 44 | + `connectedServieName` in `misc/azure-release.yml`. Note that you |
0 commit comments