update secrets token name for DocIndexRetriever.#2035
Merged
Conversation
Signed-off-by: ZePan110 <ze.pan@intel.com>
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames the environment variable for the Hugging Face token from HUGGINGFACEHUB_API_TOKEN to HF_TOKEN across Docker Compose files, shell scripts, and test documentation.
- Centralized environment exports into
set_env.shfor Xeon tests - Updated all compose YAMLs to reference
${HF_TOKEN}instead of${HUGGINGFACEHUB_API_TOKEN} - Revised README snippets in
tests/and Docker directories to useHF_TOKEN
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| DocIndexRetriever/tests/test_compose_without_rerank_on_xeon.sh | Replaced individual exports with source ./set_env.sh |
| DocIndexRetriever/tests/README.md | Changed example export to HF_TOKEN |
| DocIndexRetriever/docker_compose/intel/hpu/gaudi/set_env.sh | Swapped HUGGINGFACEHUB_API_TOKEN for HF_TOKEN |
All compose*.yaml under docker_compose/ |
Updated environment variable references to ${HF_TOKEN} |
Various README.md in Docker dirs |
Updated export examples to HF_TOKEN |
Comments suppressed due to low confidence (3)
DocIndexRetriever/tests/README.md:6
- [nitpick] The name
HF_TOKENmay be too generic; consider renaming toHF_API_TOKENorHF_HUB_TOKENfor greater clarity.
export HF_TOKEN="Your_Huggingface_API_Token"
DocIndexRetriever/tests/test_compose_without_rerank_on_xeon.sh:42
- Add a check to verify that
set_env.shexists and thatHF_TOKENis set after sourcing, e.g.[[ -f set_env.sh ]] || exit 1and[[ -n "$HF_TOKEN" ]] || { echo 'HF_TOKEN not set'; exit 1; }.
source ./set_env.sh
DocIndexRetriever/docker_compose/intel/hpu/gaudi/set_env.sh:14
- Consider validating
HF_TOKENat the top of this script to fail fast if the variable is undefined or empty.
export HF_TOKEN=${HF_TOKEN}
chensuyue
approved these changes
Jun 6, 2025
lvliang-intel
approved these changes
Jun 6, 2025
edlee123
pushed a commit
to edlee123/GenAIExamples
that referenced
this pull request
Jun 24, 2025
Signed-off-by: ZePan110 <ze.pan@intel.com> Signed-off-by: Ed Lee <16417837+edlee123@users.noreply.github.com>
alexsin368
pushed a commit
to alexsin368/GenAIExamples
that referenced
this pull request
Aug 13, 2025
Signed-off-by: ZePan110 <ze.pan@intel.com> Signed-off-by: alexsin368 <alex.sin@intel.com>
cogniware-devops
pushed a commit
to Cogniware-Inc/GenAIExamples
that referenced
this pull request
Dec 19, 2025
Signed-off-by: ZePan110 <ze.pan@intel.com> Signed-off-by: cogniware-devops <ambarish.desai@cogniware.ai>
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
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.
Description
update secrets token name for DocIndexRetriever.
Issues
#1954
Type of change
List the type of change like below. Please delete options that are not relevant.
Dependencies
List the newly introduced 3rd party dependency if exists.
Tests
Describe the tests that you ran to verify your changes.