GH-47075: [Release][Dev] Use GH_TOKEN as GitHub token environment variable #47181
+94
−81
Conversation
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
|
|
github-actions
bot
added
Component: Documentation
awaiting committer review
github-actions
bot
added
awaiting review
kou
force-pushed
the
gh-token
branch
5 times, most recently
from
da363b6 to
96e0eb1
Compare
…nt variable We can still use `ARROW_GITHUB_API_TOKEN` and `CROSSBOW_GITHUB_TOKEN` for backward compatibility but `GH_TOKEN` is recommended.
amoeba
approved these changes
Jul 24, 2025
There was a problem hiding this comment.
+1, thanks @kou. I left some comments.
Should we update this comment in .env.example too?
diff --git a/dev/release/.env.example b/dev/release/.env.example
index c1e012aacb..43af2851db 100644
--- a/dev/release/.env.example
+++ b/dev/release/.env.example
@@ -31,7 +31,7 @@
# You must set this.
#ARTIFACTORY_API_KEY=secret
-# The GitHub token to upload artifacts to GitHub Release.
+# The GitHub token used in numerous release scripts.
#
# You must set this.
#GH_TOKEN=secret| @@ -254,10 +255,13 @@ def __init__(self, project_name, cmd): | |||
| config = load_configuration() | |||
| if "github" in config.sections(): | |||
| token = config["github"]["api_token"] | |||
| if not token: | |||
| token = os.environ.get('GH_TOKEN') | |||
| if not token: | |||
There was a problem hiding this comment.
Do we want to warn people they're still using ARROW_GITHUB_API_TOKEN to allow us to fully deprecate it at some point?
There was a problem hiding this comment.
Good point. I've added warning message.
github-actions
bot
added
awaiting committer review
Co-authored-by: Bryce Mecum <petridish@gmail.com>
github-actions
bot
added
awaiting changes
github-actions
bot
added
awaiting change review
CROSSBOW_GITHUB_TOKEN is for ursacomputing/crossbow and GH_TOKEN is for apache/arrow. We may want to use different token for them.
kou
commented
Jul 25, 2025
| @@ -254,10 +255,13 @@ def __init__(self, project_name, cmd): | |||
| config = load_configuration() | |||
| if "github" in config.sections(): | |||
| token = config["github"]["api_token"] | |||
| if not token: | |||
| token = os.environ.get('GH_TOKEN') | |||
| if not token: | |||
There was a problem hiding this comment.
Good point. I've added warning message.
github-actions
bot
added
awaiting changes
|
I'll merge this. |
|
Thanks for your work on this @kou. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Rationale for this change
We have many environment variables for GitHub token:
GH_TOKEN,ARROW_GITHUB_API_TOKENandCROSSBOW_GITHUB_TOKENIt's difficult to maintain. For example, we may forget to define one of them.
What changes are included in this PR?
Use
GH_TOKENas unified environment variable for GitHub token.We can still use
ARROW_GITHUB_API_TOKENandCROSSBOW_GITHUB_TOKENfor backward compatibility butGH_TOKENis recommended.Are these changes tested?
Yes.
Are there any user-facing changes?
No.