Skip to content

update secrets token name for AgentQnA. #2023

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

Merged
merged 3 commits into from
Jun 5, 2025
Merged

update secrets token name for AgentQnA. #2023

merged 3 commits into from
Jun 5, 2025

Conversation

ZePan110
Copy link
Collaborator

@ZePan110 ZePan110 commented Jun 3, 2025

Description

  1. update secrets token name for AgentQnA.
  2. Fix Shellcheck issues

Issues

#1954
#1999

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)
  • Others (enhancement, documentation, validation, etc.)

Dependencies

List the newly introduced 3rd party dependency if exists.

Tests

Describe the tests that you ran to verify your changes.

Signed-off-by: ZePan110 <ze.pan@intel.com>
@Copilot Copilot AI review requested due to automatic review settings June 3, 2025 08:43
Copy link

github-actions bot commented Jun 3, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

The PR standardizes the environment variable name for HuggingFace tokens across scripts, Docker/YAML configs, Helm charts, workflows, and documentation.

  • Replaces HUGGINGFACEHUB_API_TOKEN with HF_TOKEN in all test and launch scripts
  • Updates Docker Compose and Helm chart environment keys to use the new variable
  • Adjusts GitHub workflows and README files to reference HF_TOKEN consistently

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.

Show a summary per file
File Description
AgentQnA/tests/*.sh Updated export of HF_TOKEN in various scripts
AgentQnA/retrieval_tool/launch_retrieval_tool.sh Swapped legacy token var for HF_TOKEN
AgentQnA/docker_compose/**/*.{sh,yaml} Changed environment var references to HF_TOKEN
AgentQnA/kubernetes/helm/README.md Updated Helm install to use HF_TOKEN
AgentQnA/README.md Updated token export example to HF_TOKEN
.github/workflows/_run-docker-compose.yml Swapped secrets to HF_TOKEN
.github/workflows/_helm-e2e.yml, _gmc-e2e.yml Updated workflows to reference HF_TOKEN
Comments suppressed due to low confidence (5)

.github/workflows/_helm-e2e.yml:169

  • The environment variable HFTOKEN lacks the underscore and is inconsistent with HF_TOKEN used elsewhere. Rename it to HF_TOKEN for consistency.
HFTOKEN: ${{ secrets.HF_TOKEN }}

.github/workflows/_helm-e2e.yml:193

  • Using ${HFTOKEN} here may be broken if the variable was renamed to HF_TOKEN. Update this reference to ${HF_TOKEN}.
--set global.HF_TOKEN=${HFTOKEN} \

AgentQnA/docker_compose/intel/hpu/gaudi/compose.yaml:19

  • The container key HUGGINGFACEHUB_API_TOKEN remains legacy—consider renaming it to HF_TOKEN (or the app’s expected key) to reflect the new standard.
HUGGINGFACEHUB_API_TOKEN: ${HF_TOKEN}

AgentQnA/docker_compose/amd/gpu/rocm/compose_vllm.yaml:14

  • Both HUGGINGFACEHUB_API_TOKEN and HF_TOKEN are declared for the same value—remove the legacy HUGGINGFACEHUB_API_TOKEN entry to avoid redundancy.
HF_TOKEN: ${HF_TOKEN}

AgentQnA/kubernetes/helm/README.md:7

  • The example uses HFTOKEN but other docs and scripts reference HF_TOKEN. Update this to export HF_TOKEN= for consistency.
export HFTOKEN="insert-your-huggingface-token-here"

@ZePan110 ZePan110 mentioned this pull request Jun 3, 2025
4 tasks
@joshuayao joshuayao linked an issue Jun 4, 2025 that may be closed by this pull request
Signed-off-by: ZePan110 <ze.pan@intel.com>
@ZePan110 ZePan110 requested a review from Spycsh as a code owner June 4, 2025 07:29
Signed-off-by: ZePan110 <ze.pan@intel.com>
@ZePan110 ZePan110 merged commit c33d0ef into main Jun 5, 2025
28 checks passed
@ZePan110 ZePan110 deleted the ze-token/Agent branch June 5, 2025 06:36
edlee123 pushed a commit to edlee123/GenAIExamples that referenced this pull request Jun 5, 2025
Signed-off-by: ZePan110 <ze.pan@intel.com>
Signed-off-by: Ed Lee <16417837+edlee123@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Standardize Hugging Face Token syntax
3 participants