apache / apache/arrow

[CI][Dev] Document how to maintain `CROSSBOW_GITHUB_TOKEN`

Open
#51,001 4 comments 0 reactions 0 assignees View on GitHub
Component: Continuous Integration Component: Developer Tools Type: enhancement
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

### Describe the enhancement requested

We're using `CROSSBOW_GITHUB_TOKEN` for comment bot:

https://github.com/apache/arrow/blob/54ea6d5babb6a1841dbe50e1cb84ae6321cd64cb/.github/workflows/comment_bot.yml#L51-L58

We need to generate a token that has suitable scope (`contents:write actions:write workflows:write`, see also [#dev > ✔ Update Crossbow tokens @ 💬](https://arrow-dev.zulipchat.com/#narrow/channel/180245-dev/topic/.E2.9C.94.20Update.20Crossbow.20tokens/near/555410591)) and ask INFRA to set it GitHub Actions secret.

We have token expiration notification mechanism: https://lists.apache.org/list?builds@arrow.apache.org:lte=3y:CROSSBOW_GITHUB_TOKEN

But I don't know how to configure it...

### Component(s)

Continuous Integration, Developer Tools

Contributor guide

Open the contributing guide

Research direction

Start with .github/workflows/comment_bot.yml at lines 51-58 to understand how CROSSBOW_GITHUB_TOKEN is used. Review the linked Zulip discussion and token-expiration notification messages, then document token generation, required scopes, and the process for asking INFRA to configure the GitHub Actions secret.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, devtools, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.