-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add docs/infrastructure.md, README contents #96
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
Open
threexc
wants to merge
3
commits into
main
Choose a base branch
from
tgamblin/docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+95
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Infrastructure | ||
|
|
||
| The [python-wheels](https://github.com/riseproject-dev/python-wheels) project | ||
| makes use of some supplemental infrastructure available both on GitHub, and | ||
| externally. The following sections outline these services and how to | ||
| configure/maintain them. | ||
|
|
||
| ## RISE RISC-V Runners | ||
|
|
||
| For RISE-hosted builds of Python wheels and upstream submissions, the | ||
| `python-wheels` repository uses the [RISC-V | ||
| Runners](https://riscv-runners.riseproject.dev/) project. It is already enabled | ||
| for the repository; to reconfigure, see the [installation | ||
| guide](https://riscv-runners.riseproject.dev/docs/getting-started/install). | ||
|
|
||
| ## GitLab | ||
|
|
||
| The `python-wheels` project is a continuation of | ||
| [wheel_builder](https://riseproject.gitlab.io/python/wheel_builder/index.html), | ||
| which is hosted on GitLab. This project leverages the GitLab CI/CD framework to | ||
| create pipelines for building, testing, and deploying wheels, along with | ||
| automatic documentation updates and periodic checks for new package versions | ||
| upstream. | ||
|
|
||
| While development and maintenance now primarily occur on GitHub, the existing | ||
| GitLab infrastructure (particularly the package registry) must be maintained. | ||
|
|
||
| ### GitLab for Open Source | ||
|
|
||
| We apply for the [GitLab for Open | ||
| Source](https://about.gitlab.com/solutions/open-source/join/) program. This | ||
| provides us with the GitLab Ultimate Plan at no cost. Membership requires annual | ||
| renewal. | ||
|
|
||
| ### CI/CD Pipeline Tokens and Access | ||
|
|
||
| The GitLab CI/CD pipelines make use of project tokens, generated at different | ||
| project scopes. Two tokens are defined: | ||
|
|
||
| 1. `PYTHON_CI_GROUP_TOKEN` - Defined at the "Group" | ||
| ([Python](https://gitlab.com/riseproject/python)) level. Used for triggering | ||
| pipelines for merge requests and most automatic updates and checks. The value | ||
| of this token is inherited by `wheel_builder` as `PYTHON_CI_GROUP_TOKEN` | ||
| under `Settings -> CI/CD Settings -> Variables` (see the [CI/CD variables | ||
| panel](https://gitlab.com/riseproject/python/wheel_builder/-/settings/ci_cd#js-cicd-variables-settings)). | ||
| 2. `rise-github-package-registry` - Defined at the "Repository" | ||
| ([wheel_builder](https://gitlab.com/riseproject/python/wheel_builder/-/settings/repository#js-deploy-tokens)) | ||
| level. Used for pushing wheels to the GitLab package registry from GitHub. | ||
|
|
||
| These tokens are generated with a 1-year expiry timeline, so they need to be | ||
| regenerated by a project administrator/owner. | ||
|
|
||
| #### Token Scope Reference | ||
|
|
||
| | Token | Level | Role | Scopes | Used For | Expiry | | ||
| |-------|-------|------|--------|----------|--------| | ||
| | `PYTHON_CI_GROUP_TOKEN` | Group ([Python](https://gitlab.com/riseproject/python)) | Maintainer | `api`, `read_api`, `read_repository`, `write_repository` | MR pipeline triggers, auto updates/checks | 1 year (Unknown expiry) | | ||
| | `rise-github-package-registry` | Repository deploy token ([wheel_builder](https://gitlab.com/riseproject/python/wheel_builder/-/settings/repository#js-deploy-tokens)) | n/a (deploy token) | `read_package_registry`, `write_package_registry` | Push wheels GitHub → GitLab package registry | 1 year (June 29th, 2027) | | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should add a link to wheel_builder documentation