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

Update Wiki to reflect changes with docker-compose #4471

Merged
merged 22 commits into from Jul 6, 2023

Conversation

kerta1n
Copy link
Contributor

@kerta1n kerta1n commented May 29, 2023

Background

Updated Docker section of wiki

Changes

docker compose is now built-in to the docker command. Previously, docker-compose was an additional binary that the user needed to download, but this is not the case anymore for users that keep their installations up to date.

Documentation

Refer to docs/setup.md

Test Plan

N/A

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

Tested that the docker-compose command does not register in terminal anymore

name change to compose.yml
name change to support Docker's documentations
Change "docker-compose" command to "docker compose" to avoid future issues with running the Docker method (`docker-compose` is v1 and is outdated, is not a recognized command with newer versions of Docker engine)
@codecov
Copy link

codecov bot commented May 29, 2023

Codecov Report

Patch coverage has no change and project coverage change: +20.57 🎉

Comparison is base (2fcd91b) 50.05% compared to head (2eb9560) 70.62%.

❗ Current head 2eb9560 differs from pull request most recent head 1715dc3. Consider uploading reports for the commit 1715dc3 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #4471       +/-   ##
===========================================
+ Coverage   50.05%   70.62%   +20.57%     
===========================================
  Files         116       69       -47     
  Lines        4799     3387     -1412     
  Branches      643      554       -89     
===========================================
- Hits         2402     2392       -10     
+ Misses       2218      811     -1407     
- Partials      179      184        +5     

see 52 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.

@Boostrix Boostrix requested a review from kinance June 3, 2023 09:38
@Boostrix
Copy link
Contributor

Boostrix commented Jun 3, 2023

thanks for working on this and for updating things !!

@kerta1n
Copy link
Contributor Author

kerta1n commented Jun 3, 2023

thanks for working on this and for updating things !!

👍👍

@Pwuts Pwuts added this to the v0.4.1 Release milestone Jun 4, 2023
@Pwuts Pwuts added documentation Improvements or additions to documentation needs discussion To be discussed among maintainers docker labels Jun 4, 2023
@Pwuts
Copy link
Member

Pwuts commented Jun 4, 2023

Some quick googling gave the following findings:

  • Compose v2 as integrated in the docker client was released on 26 April 2022
  • The final release of Compose v1 was on 10 May 2021
    • Compose v1 will no longer be shipped with Docker Desktop after June 2023
  • This PR replaces references and usage of v1 with v2

If the above is correct, I want to merge this PR ASAP.

@Pwuts Pwuts self-assigned this Jun 4, 2023
@Pwuts Pwuts removed the needs discussion To be discussed among maintainers label Jun 4, 2023
Copy link
Member

@Pwuts Pwuts left a comment

Choose a reason for hiding this comment

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

Thanks for submitting! Please also update docs/usage.md (lines 14 through 18), and I suggest reverting the rename of docker-compose.yml to compose.yml.

compose.yml Outdated Show resolved Hide resolved
@github-actions github-actions bot added the conflicts Automatically applied to PRs with merge conflicts label Jun 5, 2023
@github-actions
Copy link

github-actions bot commented Jun 5, 2023

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

@vercel
Copy link

vercel bot commented Jun 7, 2023

Deployment failed with the following error:

Resource is limited - try again in 9 hours (more than 100, code: "api-deployments-free-per-day").

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

github-actions bot commented Jun 7, 2023

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

@ntindle ntindle requested a review from Pwuts June 7, 2023 04:43
@vercel
Copy link

vercel bot commented Jun 7, 2023

Deployment failed with the following error:

Resource is limited - try again in 8 hours (more than 100, code: "api-deployments-free-per-day").

@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.

@Pwuts
Copy link
Member

Pwuts commented Jun 13, 2023

Waiting on checks to complete, but my fork now has docker-compose.yml instead of compose.yml so it should be sufficient to merge.

Well...

As mentioned in previous review: please also update docs/usage.md (lines 14 through 18)

@lc0rp lc0rp modified the milestones: v0.4.1 Release, v0.4.2 Release Jun 14, 2023
@lc0rp
Copy link
Contributor

lc0rp commented Jun 21, 2023

As mentioned in previous review: please also update docs/usage.md (lines 14 through 18)

@kerta1n bump

@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.

@kerta1n
Copy link
Contributor Author

kerta1n commented Jun 21, 2023

So sorry for not updating this earlier 😭, this should be correct

@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.

docker-compose.yml Outdated Show resolved Hide resolved
@ntindle ntindle requested a review from Pwuts June 24, 2023 06:05
@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.

@kerta1n
Copy link
Contributor Author

kerta1n commented Jun 25, 2023

As mentioned in previous review: please also update docs/usage.md (lines 14 through 18)

Ready to be resolved

@lc0rp lc0rp modified the milestones: v0.4.3 Release, v0.4.4 Release Jun 26, 2023
@lc0rp lc0rp removed the request for review from kinance July 3, 2023 19:16
@lc0rp
Copy link
Contributor

lc0rp commented Jul 3, 2023

LGTM

@Pwuts Pwuts merged commit e088295 into Significant-Gravitas:master Jul 6, 2023
14 checks passed
@kerta1n
Copy link
Contributor Author

kerta1n commented Jul 7, 2023

Small change, but thanks everyone!!

dayofthedave pushed a commit to dayofthedave/Auto-GPT that referenced this pull request Jul 17, 2023
* Update setup.md

Change "docker-compose" command to "docker compose" to avoid future issues with running the Docker method (`docker-compose` is v1 and is outdated, is not a recognized command with newer versions of Docker engine)

* Update usage.md

* Update comment in docker-compose.yml

---------

Co-authored-by: Reinier van der Leer <github@pwuts.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
behaviour change docker documentation Improvements or additions to documentation size/m
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

6 participants