Skip to content
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

Define env var for docsearch API key in dev-docs build script #6187

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eapolinario
Copy link
Contributor

@eapolinario eapolinario commented Jan 23, 2025

Why are the changes needed?

We need the env var to be present, otherwise make dev-docs fails with:

...
You must provide your Algolia search API key for DocSearch to work.
...

What changes were proposed in this pull request?

Pipe an env var called DOCSEARCH_API_KEY to the command used to build dev docs.

How was this patch tested?

set the env var and ran make dev-docs successfully.

Labels

Please add one or more of the following labels to categorize your PR:

  • added: For new features.
  • changed: For changes in existing functionality.
  • deprecated: For soon-to-be-removed features.
  • removed: For features being removed.
  • fixed: For any bug fixed.
  • security: In case of vulnerabilities

This is important to improve the readability of release notes.

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

Summary by Bito

This pull request introduces a feature improvement by adding an environment variable, DOCSEARCH_API_KEY, to the local build script for documentation, enhancing the build process for development documentation.

Unit tests added: False

Estimated effort to review (1-5, lower is better): 1

@flyte-bot
Copy link
Collaborator

flyte-bot commented Jan 23, 2025

Code Review Agent Run #dc5ded

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 99b3bc3..99b3bc3
    • script/local_build_docs.sh
  • Files skipped - 0
  • Tools
    • Golangci-lint (Linter) - ✖︎ Failed
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

AI Code Review powered by Bito Logo

@flyte-bot
Copy link
Collaborator

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Feature Improvement - Add Environment Variable for DocSearch API Key

local_build_docs.sh - Added environment variable DOCSEARCH_API_KEY to support dev-docs build.

Copy link

codecov bot commented Jan 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.07%. Comparing base (7c84707) to head (99b3bc3).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6187   +/-   ##
=======================================
  Coverage   37.06%   37.07%           
=======================================
  Files        1318     1318           
  Lines      132644   132652    +8     
=======================================
+ Hits        49160    49175   +15     
+ Misses      79235    79228    -7     
  Partials     4249     4249           
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.33% <ø> (+0.02%) ⬆️
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.29% <ø> (ø)
unittests-flyteidl 7.23% <ø> (ø)
unittests-flyteplugins 53.87% <ø> (ø)
unittests-flytepropeller 42.70% <ø> (ø)
unittests-flytestdlib 55.35% <ø> (+0.07%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

2 participants