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

Readme is subtly out of date regarding workflows and API keys #244

Open
EliahKagan opened this issue Sep 30, 2023 · 0 comments
Open

Readme is subtly out of date regarding workflows and API keys #244

EliahKagan opened this issue Sep 30, 2023 · 0 comments

Comments

@EliahKagan
Copy link
Collaborator

This still gives the right idea, but it is out of date:

Once enabled, some of the workflows will run without problems. Some others—the
automated tests in [`test_embed`](tests/test_embed.py)—cannot run successfully
without an OpenAI API key.

There are two problems:

  • We have other test modules than test_embed.py, some of which have tests that require OPENAI_API_KEY.
  • No test modules run on CI without that secret set up, because the workflow is written to check for it first.

So this should be updated. But we should avoid inadvertently claiming that every test case requires OPENAI_API_KEY, which isn't the case: there are some tests that pass without it (and should), just we're not running any tests on CI when OPENAI_API_KEY is unavailable. Preferably the explanation should be kept as short and simple as it is now, though.

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

No branches or pull requests

1 participant