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

Clean up and fix issues with env configuration and .env.template #4630

Merged

Conversation

erik-megarad
Copy link
Contributor

@erik-megarad erik-megarad commented Jun 8, 2023

Background

The configuration available is sometimes not documented, frequently doesn't make sense, has unused settings, amongst other issues.

The .env.template file is hard to read and as a new user it's really difficult to figure out what's going on.

Changes

  • Clean up and standardize format of the .env.template file. Commented-out environment variables should always be set to the default value, and not an example value.
  • Add a separate doc page for documentation of config variables that either did not exist or lived in the .env.template
  • Rework configuration for image generation as it was messy and confusing.
  • Set audio to text provider configuration to be the same as the other providers
  • Rename CUSTOM_SEARCH_ENGINE_ID to GOOGLE_CUSTOM_SEARCH_ENGINE_ID
  • Remove Twitter configuration from the .env template since it is no longer part of Auto-GPT core
  • Rework configuration for text-to-speech so that the provider isn't magically divined from other settings

Documentation

It's all docs

Test Plan

Unit tests, setting values and running myself

PR Quality Checklist

  • My pull request is atomic and focuses on a single change.
  • I have thoroughly tested my changes with multiple different prompts.
  • I have considered potential risks and mitigations for my changes.
  • I have documented my changes clearly and comprehensively.
  • I have not snuck in any "extra" small tweaks changes.
  • I have run the following commands against my code to ensure it passes our linters:
    black .
    isort .
    mypy
    autoflake --remove-all-unused-imports --recursive --ignore-init-module-imports autogpt tests --in-place

@vercel
Copy link

vercel bot commented Jun 8, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 9, 2023 10:24pm

@github-actions github-actions bot added the size/l label Jun 8, 2023
@vercel vercel bot temporarily deployed to Preview June 8, 2023 23:27 Inactive
@erik-megarad erik-megarad changed the title Streamline / clarify shell command control configuration Clean up and fix issues with env configuration and .env.template Jun 8, 2023
@vercel vercel bot temporarily deployed to Preview June 8, 2023 23:39 Inactive
@codecov
Copy link

codecov bot commented Jun 8, 2023

Codecov Report

Patch coverage: 44.44% and project coverage change: -0.25 ⚠️

Comparison is base (3081f56) 69.81% compared to head (9534144) 69.56%.

❗ Current head 9534144 differs from pull request most recent head 9374623. Consider uploading reports for the commit 9374623 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4630      +/-   ##
==========================================
- Coverage   69.81%   69.56%   -0.25%     
==========================================
  Files          72       72              
  Lines        3571     3568       -3     
  Branches      568      571       +3     
==========================================
- Hits         2493     2482      -11     
- Misses        890      896       +6     
- Partials      188      190       +2     
Impacted Files Coverage Δ
autogpt/speech/eleven_labs.py 28.57% <0.00%> (ø)
autogpt/commands/audio_text.py 31.03% <11.11%> (-5.33%) ⬇️
autogpt/speech/say.py 36.66% <14.28%> (ø)
autogpt/config/config.py 71.52% <52.00%> (-3.14%) ⬇️
autogpt/commands/execute_code.py 70.11% <85.71%> (-3.42%) ⬇️
autogpt/commands/google_search.py 95.74% <100.00%> (ø)
autogpt/speech/stream_elements_speech.py 44.44% <100.00%> (ø)

... and 4 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@github-actions github-actions bot added the conflicts Automatically applied to PRs with merge conflicts label Jun 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 9, 2023

This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.

@github-actions github-actions bot removed the conflicts Automatically applied to PRs with merge conflicts label Jun 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 9, 2023

Conflicts have been resolved! 🎉 A maintainer will review the pull request shortly.

@vercel vercel bot temporarily deployed to Preview June 9, 2023 20:18 Inactive
@Auto-GPT-Bot
Copy link
Contributor

You changed AutoGPT's behaviour. The cassettes have been updated and will be merged to the submodule when this Pull Request gets merged.

@erik-megarad erik-megarad marked this pull request as ready for review June 9, 2023 20:21
@vercel vercel bot temporarily deployed to Preview June 9, 2023 22:24 Inactive
@waynehamadi waynehamadi merged commit 5fe600a into Significant-Gravitas:master Jun 9, 2023
@Pwuts Pwuts added this to the v0.4.1 Release milestone Jun 11, 2023
.env.template Show resolved Hide resolved
lc0rp added a commit that referenced this pull request Jun 19, 2023
Co-authored-by: Reinier van der Leer <github@pwuts.nl>
Co-authored-by: Nicholas Tindle <nick@ntindle.com>
Co-authored-by: Nicholas Tindle <nicktindle@outlook.com>
Co-authored-by: k-boikov <64261260+k-boikov@users.noreply.github.com>
Co-authored-by: merwanehamadi <merwanehamadi@gmail.com>
Co-authored-by: Merwane Hamadi <merwanehamadi@gmail.com>
Co-authored-by: Richard Beales <rich@richbeales.net>
Co-authored-by: Luke K <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Luke K (pr-0f3t) <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Erik Peterson <e@eriklp.com>
Co-authored-by: Auto-GPT-Bot <github-bot@agpt.co>
Co-authored-by: Benny van der Lans <49377421+bfalans@users.noreply.github.com>
Co-authored-by: Jan <jan-github@phobia.de>
Co-authored-by: Robin Richtsfeld <robin.richtsfeld@gmail.com>
Co-authored-by: Marc Bornträger <marc.borntraeger@gmail.com>
Co-authored-by: Stefan Ayala <stefanayala3266@gmail.com>
Co-authored-by: javableu <45064273+javableu@users.noreply.github.com>
Co-authored-by: DGdev91 <DGdev91@users.noreply.github.com>
Co-authored-by: Kinance <kinance@gmail.com>
Co-authored-by: digger yu <digger-yu@outlook.com>
Co-authored-by: David <scenaristeur@gmail.com>
Co-authored-by: gravelBridge <john.tian31@gmail.com>
Fix Python CI "update cassettes" step (#4591)
fix CI (#4596)
Fix inverted logic for deny_command (#4563)
fix current_score.json generation (#4601)
Fix duckduckgo rate limiting (#4592)
Fix debug code challenge (#4632)
Fix issues with information retrieval challenge a (#4622)
fix issues with env configuration and .env.template (#4630)
Fix prompt issue causing 'No Command' issues and challenge to fail (#4623)
Fix benchmark logs (#4653)
Fix typo in docs/setup.md (#4613)
Fix run.sh shebang (#4561)
Fix autogpt docker image not working because missing prompt_settings (#4680)
Fix execute_command coming from plugins (#4730)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants