Skip to content

MINOR: [CI] Document Crossbow GitHub token maintenance #51119

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.

Sign up for GitHub

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
berringtoni36-commits wants to merge 1 commit into
base: main
Choose a base branch
from
Open

MINOR: [CI] Document Crossbow GitHub token maintenance #51119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions docs/source/developers/continuous_integration/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,22 @@ The ``.yml`` files in ``.github/workflows`` are workflows which are run on GitHu
- ``dev.yml`` - runs any time there is activity on a PR, or a PR is merged; it runs the linter and tests that the PR can be merged
- ``dev_pr.yml`` - runs any time a PR is opened or updated; checks the formatting of the PR title, adds assignee to the appropriate GitHub issue if needed (or adds a comment requesting the user to include the issue id in the title), and adds any relevant GitHub labels

Maintaining the Crossbow GitHub token
-------------------------------------

The ``comment_bot.yml`` workflow uses ``CROSSBOW_GITHUB_TOKEN`` when it
submits Crossbow jobs from pull-request comments. The token must have the
following GitHub scopes:

- ``contents:write``
- ``actions:write``
- ``workflows:write``

When the token-expiration notification is received, generate a replacement
token with these scopes and send it to Apache INFRA. INFRA updates the
``CROSSBOW_GITHUB_TOKEN`` Actions secret. The replacement also needs to be
updated in the Crossbow repository and in the Azure Pipelines configuration.

Extended builds
-----------------------

Expand Down