Fix CI/CD for Auto-GPT + docs site deployment
|
@ -3,18 +3,23 @@ name: Python CI
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [ master, ci-test* ]
|
branches: [ master, ci-test* ]
|
||||||
paths-ignore:
|
paths:
|
||||||
- 'tests/Auto-GPT-test-cassettes'
|
- 'autogpts/autogpt'
|
||||||
- 'tests/challenges/current_score.json'
|
- '!autogpts/autogpt/tests/Auto-GPT-test-cassettes'
|
||||||
|
- '!autogpts/autogpt/tests/challenges/current_score.json'
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [ stable, master, release-* ]
|
branches: [ stable, master, release-* ]
|
||||||
pull_request_target:
|
pull_request_target:
|
||||||
branches: [ master, release-*, ci-test* ]
|
branches: [ master, release-*, ci-test* ]
|
||||||
|
|
||||||
concurrency:
|
concurrency:
|
||||||
group: ${{ format('ci-{0}', github.head_ref && format('{0}-{1}', github.event_name, github.event.pull_request.number) || github.sha) }}
|
group: ${{ format('autogpt-ci-{0}', github.head_ref && format('{0}-{1}', github.event_name, github.event.pull_request.number) || github.sha) }}
|
||||||
cancel-in-progress: ${{ startsWith(github.event_name, 'pull_request') }}
|
cancel-in-progress: ${{ startsWith(github.event_name, 'pull_request') }}
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: autogpts/autogpt
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint:
|
||||||
# eliminate duplicate runs
|
# eliminate duplicate runs
|
||||||
|
@ -258,4 +263,4 @@ jobs:
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: test-logs
|
name: test-logs
|
||||||
path: logs/
|
path: autogpts/autogpt/logs/
|
|
@ -1,4 +1,4 @@
|
||||||
name: Purge Docker CI cache
|
name: Purge Auto-GPT Docker CI cache
|
||||||
|
|
||||||
on:
|
on:
|
||||||
schedule:
|
schedule:
|
||||||
|
@ -28,7 +28,7 @@ jobs:
|
||||||
build-args: BUILD_TYPE=${{ matrix.build-type }}
|
build-args: BUILD_TYPE=${{ matrix.build-type }}
|
||||||
load: true # save to docker images
|
load: true # save to docker images
|
||||||
# use GHA cache as read-only
|
# use GHA cache as read-only
|
||||||
cache-to: type=gha,scope=docker-${{ matrix.build-type }},mode=max
|
cache-to: type=gha,scope=autogpt-docker-${{ matrix.build-type }},mode=max
|
||||||
|
|
||||||
- name: Generate build report
|
- name: Generate build report
|
||||||
env:
|
env:
|
|
@ -1,18 +1,23 @@
|
||||||
name: Docker CI
|
name: Auto-GPT Docker CI
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [ master ]
|
branches: [ master ]
|
||||||
paths-ignore:
|
paths:
|
||||||
- 'tests/Auto-GPT-test-cassettes'
|
- 'autogpts/autogpt'
|
||||||
- 'tests/challenges/current_score.json'
|
- '!autogpts/autogpt/tests/Auto-GPT-test-cassettes'
|
||||||
|
- '!autogpts/autogpt/tests/challenges/current_score.json'
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [ master, release-*, stable ]
|
branches: [ master, release-*, stable ]
|
||||||
|
|
||||||
concurrency:
|
concurrency:
|
||||||
group: ${{ format('docker-ci-{0}', github.head_ref && format('pr-{0}', github.event.pull_request.number) || github.sha) }}
|
group: ${{ format('autogpt-docker-ci-{0}', github.head_ref && format('pr-{0}', github.event.pull_request.number) || github.sha) }}
|
||||||
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
|
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: autogpts/autogpt
|
||||||
|
|
||||||
env:
|
env:
|
||||||
IMAGE_NAME: auto-gpt
|
IMAGE_NAME: auto-gpt
|
||||||
|
|
||||||
|
@ -38,12 +43,13 @@ jobs:
|
||||||
name: Build image
|
name: Build image
|
||||||
uses: docker/build-push-action@v3
|
uses: docker/build-push-action@v3
|
||||||
with:
|
with:
|
||||||
|
context: autogpts/autogpt
|
||||||
build-args: BUILD_TYPE=${{ matrix.build-type }}
|
build-args: BUILD_TYPE=${{ matrix.build-type }}
|
||||||
tags: ${{ env.IMAGE_NAME }}
|
tags: ${{ env.IMAGE_NAME }}
|
||||||
load: true # save to docker images
|
load: true # save to docker images
|
||||||
# cache layers in GitHub Actions cache to speed up builds
|
# cache layers in GitHub Actions cache to speed up builds
|
||||||
cache-from: type=gha,scope=docker-${{ matrix.build-type }}
|
cache-from: type=gha,scope=autogpt-docker-${{ matrix.build-type }}
|
||||||
cache-to: type=gha,scope=docker-${{ matrix.build-type }},mode=max
|
cache-to: type=gha,scope=autogpt-docker-${{ matrix.build-type }},mode=max
|
||||||
|
|
||||||
- name: Generate build report
|
- name: Generate build report
|
||||||
env:
|
env:
|
||||||
|
@ -71,6 +77,7 @@ jobs:
|
||||||
vars_json: ${{ toJSON(vars) }}
|
vars_json: ${{ toJSON(vars) }}
|
||||||
|
|
||||||
run: .github/workflows/scripts/docker-ci-summary.sh >> $GITHUB_STEP_SUMMARY
|
run: .github/workflows/scripts/docker-ci-summary.sh >> $GITHUB_STEP_SUMMARY
|
||||||
|
working-directory: ./
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
|
|
||||||
test:
|
test:
|
||||||
|
@ -89,12 +96,13 @@ jobs:
|
||||||
name: Build image
|
name: Build image
|
||||||
uses: docker/build-push-action@v3
|
uses: docker/build-push-action@v3
|
||||||
with:
|
with:
|
||||||
|
context: autogpts/autogpt
|
||||||
build-args: BUILD_TYPE=dev # include pytest
|
build-args: BUILD_TYPE=dev # include pytest
|
||||||
tags: ${{ env.IMAGE_NAME }}
|
tags: ${{ env.IMAGE_NAME }}
|
||||||
load: true # save to docker images
|
load: true # save to docker images
|
||||||
# cache layers in GitHub Actions cache to speed up builds
|
# cache layers in GitHub Actions cache to speed up builds
|
||||||
cache-from: type=gha,scope=docker-dev
|
cache-from: type=gha,scope=autogpt-docker-dev
|
||||||
cache-to: type=gha,scope=docker-dev,mode=max
|
cache-to: type=gha,scope=autogpt-docker-dev,mode=max
|
||||||
|
|
||||||
- id: test
|
- id: test
|
||||||
name: Run tests
|
name: Run tests
|
|
@ -1,4 +1,4 @@
|
||||||
name: Docker Release
|
name: Auto-GPT Docker Release
|
||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
|
@ -10,6 +10,10 @@ on:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: 'Build from scratch, without using cached layers'
|
description: 'Build from scratch, without using cached layers'
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: autogpts/autogpt
|
||||||
|
|
||||||
env:
|
env:
|
||||||
IMAGE_NAME: auto-gpt
|
IMAGE_NAME: auto-gpt
|
||||||
DEPLOY_IMAGE_NAME: ${{ secrets.DOCKER_USER }}/auto-gpt
|
DEPLOY_IMAGE_NAME: ${{ secrets.DOCKER_USER }}/auto-gpt
|
||||||
|
@ -41,6 +45,7 @@ jobs:
|
||||||
name: Build image
|
name: Build image
|
||||||
uses: docker/build-push-action@v3
|
uses: docker/build-push-action@v3
|
||||||
with:
|
with:
|
||||||
|
context: autogpts/autogpt
|
||||||
build-args: BUILD_TYPE=release
|
build-args: BUILD_TYPE=release
|
||||||
load: true # save to docker images
|
load: true # save to docker images
|
||||||
# push: true # TODO: uncomment when this issue is fixed: https://github.com/moby/buildkit/issues/1555
|
# push: true # TODO: uncomment when this issue is fixed: https://github.com/moby/buildkit/issues/1555
|
||||||
|
@ -50,8 +55,8 @@ jobs:
|
||||||
${{ env.DEPLOY_IMAGE_NAME }}:${{ steps.sanitize_tag.outputs.tag }}
|
${{ env.DEPLOY_IMAGE_NAME }}:${{ steps.sanitize_tag.outputs.tag }}
|
||||||
|
|
||||||
# cache layers in GitHub Actions cache to speed up builds
|
# cache layers in GitHub Actions cache to speed up builds
|
||||||
cache-from: ${{ !inputs.no_cache && 'type=gha' || '' }},scope=docker-release
|
cache-from: ${{ !inputs.no_cache && 'type=gha' || '' }},scope=autogpt-docker-release
|
||||||
cache-to: type=gha,scope=docker-release,mode=max
|
cache-to: type=gha,scope=autogpt-docker-release,mode=max
|
||||||
|
|
||||||
- name: Push image to Docker Hub
|
- name: Push image to Docker Hub
|
||||||
run: docker push --all-tags ${{ env.DEPLOY_IMAGE_NAME }}
|
run: docker push --all-tags ${{ env.DEPLOY_IMAGE_NAME }}
|
||||||
|
@ -78,4 +83,5 @@ jobs:
|
||||||
vars_json: ${{ toJSON(vars) }}
|
vars_json: ${{ toJSON(vars) }}
|
||||||
|
|
||||||
run: .github/workflows/scripts/docker-release-summary.sh >> $GITHUB_STEP_SUMMARY
|
run: .github/workflows/scripts/docker-release-summary.sh >> $GITHUB_STEP_SUMMARY
|
||||||
|
working-directory: ./
|
||||||
continue-on-error: true
|
continue-on-error: true
|
|
@ -5,8 +5,8 @@ on:
|
||||||
push:
|
push:
|
||||||
branches: [ master, release-* ]
|
branches: [ master, release-* ]
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- 'tests/Auto-GPT-test-cassettes'
|
- 'autogpts/autogpt/tests/Auto-GPT-test-cassettes'
|
||||||
- 'tests/challenges/current_score.json'
|
- 'autogpts/autogpt/tests/challenges/current_score.json'
|
||||||
# So that the `dirtyLabel` is removed if conflicts are resolve
|
# So that the `dirtyLabel` is removed if conflicts are resolve
|
||||||
# We recommend `pull_request_target` so that github secrets are available.
|
# We recommend `pull_request_target` so that github secrets are available.
|
||||||
# In `pull_request` we wouldn't be able to change labels of fork PRs
|
# In `pull_request` we wouldn't be able to change labels of fork PRs
|
|
@ -1,3 +0,0 @@
|
||||||
# These are supported funding model platforms
|
|
||||||
|
|
||||||
github: Torantulino
|
|
|
@ -1,164 +0,0 @@
|
||||||
name: Bug report 🐛
|
|
||||||
description: Create a bug report for Auto-GPT.
|
|
||||||
labels: ['status: needs triage']
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
### ⚠️ Before you continue
|
|
||||||
* Check out our [backlog], [roadmap] and join our [discord] to discuss what's going on
|
|
||||||
* If you need help, you can ask in the [discussions] section or in [#tech-support]
|
|
||||||
* **Thoroughly search the [existing issues] before creating a new one**
|
|
||||||
* Read our [wiki page on Contributing]
|
|
||||||
[backlog]: https://github.com/orgs/Significant-Gravitas/projects/1
|
|
||||||
[roadmap]: https://github.com/orgs/Significant-Gravitas/projects/2
|
|
||||||
[discord]: https://discord.gg/autogpt
|
|
||||||
[discussions]: https://github.com/Significant-Gravitas/Auto-GPT/discussions
|
|
||||||
[#tech-support]: https://discord.com/channels/1092243196446249134/1092275629602394184
|
|
||||||
[existing issues]: https://github.com/Significant-Gravitas/Auto-GPT/issues?q=is%3Aissue
|
|
||||||
[wiki page on Contributing]: https://github.com/Significant-Gravitas/Nexus/wiki/Contributing
|
|
||||||
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: ⚠️ Search for existing issues first ⚠️
|
|
||||||
description: >
|
|
||||||
Please [search the history](https://github.com/Torantulino/Auto-GPT/issues)
|
|
||||||
to see if an issue already exists for the same problem.
|
|
||||||
options:
|
|
||||||
- label: I have searched the existing issues, and there is no existing issue for my problem
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Please confirm that the issue you have is described well and precise in the title above ⬆️.
|
|
||||||
A good rule of thumb: What would you type if you were searching for the issue?
|
|
||||||
|
|
||||||
For example:
|
|
||||||
BAD - my auto-gpt keeps looping
|
|
||||||
GOOD - After performing execute_python_file, auto-gpt goes into a loop where it keeps trying to execute the file.
|
|
||||||
|
|
||||||
⚠️ SUPER-busy repo, please help the volunteer maintainers.
|
|
||||||
The less time we spend here, the more time we can spend building AutoGPT.
|
|
||||||
|
|
||||||
Please help us help you by following these steps:
|
|
||||||
- Search for existing issues, adding a comment when you have the same or similar issue is tidier than "new issue" and
|
|
||||||
newer issues will not be reviewed earlier, this is dependent on the current priorities set by our wonderful team
|
|
||||||
- Ask on our Discord if your issue is known when you are unsure (https://discord.gg/autogpt)
|
|
||||||
- Provide relevant info:
|
|
||||||
- Provide commit-hash (`git rev-parse HEAD` gets it) if possible
|
|
||||||
- If it's a pip/packages issue, mention this in the title and provide pip version, python version
|
|
||||||
- If it's a crash, provide traceback and describe the error you got as precise as possible in the title.
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Which Operating System are you using?
|
|
||||||
description: >
|
|
||||||
Please select the operating system you were using to run Auto-GPT when this problem occurred.
|
|
||||||
options:
|
|
||||||
- Windows
|
|
||||||
- Linux
|
|
||||||
- MacOS
|
|
||||||
- Docker
|
|
||||||
- Devcontainer / Codespace
|
|
||||||
- Windows Subsystem for Linux (WSL)
|
|
||||||
- Other
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
nested_fields:
|
|
||||||
- type: text
|
|
||||||
attributes:
|
|
||||||
label: Specify the system
|
|
||||||
description: Please specify the system you are working on.
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Which version of Auto-GPT are you using?
|
|
||||||
description: |
|
|
||||||
Please select which version of Auto-GPT you were using when this issue occurred.
|
|
||||||
If you downloaded the code from the [releases page](https://github.com/Significant-Gravitas/Auto-GPT/releases/) make sure you were using the latest code.
|
|
||||||
**If you weren't please try with the [latest code](https://github.com/Significant-Gravitas/Auto-GPT/releases/)**.
|
|
||||||
If installed with git you can run `git branch` to see which version of Auto-GPT you are running.
|
|
||||||
options:
|
|
||||||
- Latest Release
|
|
||||||
- Stable (branch)
|
|
||||||
- Master (branch)
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Do you use OpenAI GPT-3 or GPT-4?
|
|
||||||
description: >
|
|
||||||
If you are using Auto-GPT with `--gpt3only`, your problems may be caused by
|
|
||||||
the [limitations](https://github.com/Significant-Gravitas/Auto-GPT/issues?q=is%3Aissue+label%3A%22AI+model+limitation%22) of GPT-3.5.
|
|
||||||
options:
|
|
||||||
- GPT-3.5
|
|
||||||
- GPT-4
|
|
||||||
- GPT-4(32k)
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Which area covers your issue best?
|
|
||||||
description: >
|
|
||||||
Select the area related to the issue you are reporting.
|
|
||||||
options:
|
|
||||||
- Installation and setup
|
|
||||||
- Memory
|
|
||||||
- Performance
|
|
||||||
- Prompt
|
|
||||||
- Commands
|
|
||||||
- Plugins
|
|
||||||
- AI Model Limitations
|
|
||||||
- Challenges
|
|
||||||
- Documentation
|
|
||||||
- Logging
|
|
||||||
- Agents
|
|
||||||
- Other
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
autolabels: true
|
|
||||||
nested_fields:
|
|
||||||
- type: text
|
|
||||||
attributes:
|
|
||||||
label: Specify the area
|
|
||||||
description: Please specify the area you think is best related to the issue.
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Describe your issue.
|
|
||||||
description: Describe the problem you are experiencing. Try to describe only the issue and phrase it short but clear. ⚠️ Provide NO other data in this field
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
#Following are optional file content uploads
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
⚠️The following is OPTIONAL, please keep in mind that the log files may contain personal information such as credentials.⚠️
|
|
||||||
|
|
||||||
"The log files are located in the folder 'logs' inside the main auto-gpt folder."
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Upload Activity Log Content
|
|
||||||
description: |
|
|
||||||
Upload the activity log content, this can help us understand the issue better.
|
|
||||||
To do this, go to the folder logs in your main auto-gpt folder, open activity.log and copy/paste the contents to this field.
|
|
||||||
⚠️ The activity log may contain personal data given to auto-gpt by you in prompt or input as well as
|
|
||||||
any personal information that auto-gpt collected out of files during last run. Do not add the activity log if you are not comfortable with sharing it. ⚠️
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Upload Error Log Content
|
|
||||||
description: |
|
|
||||||
Upload the error log content, this will help us understand the issue better.
|
|
||||||
To do this, go to the folder logs in your main auto-gpt folder, open error.log and copy/paste the contents to this field.
|
|
||||||
⚠️ The error log may contain personal data given to auto-gpt by you in prompt or input as well as
|
|
||||||
any personal information that auto-gpt collected out of files during last run. Do not add the activity log if you are not comfortable with sharing it. ⚠️
|
|
||||||
validations:
|
|
||||||
required: false
|
|
|
@ -1,28 +0,0 @@
|
||||||
name: Feature request 🚀
|
|
||||||
description: Suggest a new idea for Auto-GPT!
|
|
||||||
labels: ['status: needs triage']
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
First, check out our [wiki page on Contributing](https://github.com/Significant-Gravitas/Nexus/wiki/Contributing)
|
|
||||||
Please provide a searchable summary of the issue in the title above ⬆️.
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Duplicates
|
|
||||||
description: Please [search the history](https://github.com/Torantulino/Auto-GPT/issues) to see if an issue already exists for the same problem.
|
|
||||||
options:
|
|
||||||
- label: I have searched the existing issues
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Summary 💡
|
|
||||||
description: Describe how it should work.
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Examples 🌈
|
|
||||||
description: Provide a link to other implementations, or screenshots of the expected behavior.
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Motivation 🔦
|
|
||||||
description: What are you trying to accomplish? How has the lack of this feature affected you? Providing context helps us come up with a solution that is more useful in the real world.
|
|
|
@ -1,49 +0,0 @@
|
||||||
<!-- ⚠️ At the moment any non-essential commands are not being merged.
|
|
||||||
If you want to add non-essential commands to Auto-GPT, please create a plugin instead.
|
|
||||||
We are expecting to ship plugin support within the week (PR #757).
|
|
||||||
Resources:
|
|
||||||
* https://github.com/Significant-Gravitas/Auto-GPT-Plugin-Template
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- 📢 Announcement
|
|
||||||
We've recently noticed an increase in pull requests focusing on combining multiple changes. While the intentions behind these PRs are appreciated, it's essential to maintain a clean and manageable git history. To ensure the quality of our repository, we kindly ask you to adhere to the following guidelines when submitting PRs:
|
|
||||||
|
|
||||||
Focus on a single, specific change.
|
|
||||||
Do not include any unrelated or "extra" modifications.
|
|
||||||
Provide clear documentation and explanations of the changes made.
|
|
||||||
Ensure diffs are limited to the intended lines — no applying preferred formatting styles or line endings (unless that's what the PR is about).
|
|
||||||
For guidance on committing only the specific lines you have changed, refer to this helpful video: https://youtu.be/8-hSNHHbiZg
|
|
||||||
|
|
||||||
Check out our [wiki page on Contributing](https://github.com/Significant-Gravitas/Nexus/wiki/Contributing)
|
|
||||||
|
|
||||||
By following these guidelines, your PRs are more likely to be merged quickly after testing, as long as they align with the project's overall direction. -->
|
|
||||||
|
|
||||||
### Background
|
|
||||||
<!-- Provide a concise overview of the rationale behind this change. Include relevant context, prior discussions, or links to related issues. Ensure that the change aligns with the project's overall direction. -->
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
<!-- Describe the specific, focused change made in this pull request. Detail the modifications clearly and avoid any unrelated or "extra" changes. -->
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
<!-- Explain how your changes are documented, such as in-code comments or external documentation. Ensure that the documentation is clear, concise, and easy to understand. -->
|
|
||||||
|
|
||||||
### Test Plan
|
|
||||||
<!-- Describe how you tested this functionality. Include steps to reproduce, relevant test cases, and any other pertinent information. -->
|
|
||||||
|
|
||||||
### 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. <!-- Submit these as separate Pull Requests, they are the easiest to merge! -->
|
|
||||||
- [ ] I have run the following commands against my code to ensure it passes our linters:
|
|
||||||
```shell
|
|
||||||
black .
|
|
||||||
isort .
|
|
||||||
mypy
|
|
||||||
autoflake --remove-all-unused-imports --recursive --ignore-init-module-imports --ignore-pass-after-docstring autogpt tests --in-place
|
|
||||||
```
|
|
||||||
|
|
||||||
<!-- If you haven't added tests, please explain why. If you have, check the appropriate box. If you've ensured your PR is atomic and well-documented, check the corresponding boxes. -->
|
|
||||||
|
|
||||||
<!-- By submitting this, I agree that my pull request should be closed if I do not fill this out or follow the guidelines. -->
|
|
|
@ -1,37 +0,0 @@
|
||||||
name: Docs
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [ stable ]
|
|
||||||
paths:
|
|
||||||
- 'docs/**'
|
|
||||||
- 'mkdocs.yml'
|
|
||||||
- '.github/workflows/documentation.yml'
|
|
||||||
|
|
||||||
# Allows you to run this workflow manually from the Actions tab
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
deploy:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Set up Python 3
|
|
||||||
uses: actions/setup-python@v4
|
|
||||||
with:
|
|
||||||
python-version: 3.x
|
|
||||||
|
|
||||||
- name: Set up workflow cache
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
key: ${{ github.ref }}
|
|
||||||
path: .cache
|
|
||||||
|
|
||||||
- run: pip install mkdocs-material
|
|
||||||
|
|
||||||
- run: mkdocs gh-deploy --force
|
|
|
@ -1,7 +0,0 @@
|
||||||
# Auto-GPT
|
|
||||||
|
|
||||||
Welcome to Auto-GPT. Please follow the [Installation](/setup/) guide to get started.
|
|
||||||
|
|
||||||
NOTE: It is recommended to use a virtual machine/container (docker) for tasks that require high security measures to prevent any potential harm to the main computer's system and data. If you are considering to use Auto-GPT outside a virtualized/containerized environment, you are *strongly* advised to use a separate user account just for running Auto-GPT. This is even more important if you are going to allow Auto-GPT to write/execute scripts and run shell commands!
|
|
||||||
|
|
||||||
It is for these reasons that executing python scripts is explicitly disabled when running outside a container environment.
|
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 504 KiB After Width: | Height: | Size: 504 KiB |
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 309 KiB After Width: | Height: | Size: 309 KiB |
|
@ -0,0 +1,8 @@
|
||||||
|
# AutoGPT docs
|
||||||
|
|
||||||
|
Welcome to AutoGPT. Please follow the [Installation](/setup/) guide to get started.
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
It is recommended to use a virtual machine/container (docker) for tasks that require high security measures to prevent any potential harm to the main computer's system and data. If you are considering to use Auto-GPT outside a virtualized/containerized environment, you are *strongly* advised to use a separate user account just for running Auto-GPT. This is even more important if you are going to allow Auto-GPT to write/execute scripts and run shell commands!
|
||||||
|
|
||||||
|
It is for these reasons that executing python scripts is explicitly disabled when running outside a container environment.
|
|
@ -1,6 +1,7 @@
|
||||||
site_name: Auto-GPT
|
site_name: AutoGPT Documentation
|
||||||
site_url: https://docs.agpt.co/
|
site_url: https://docs.agpt.co/
|
||||||
repo_url: https://github.com/Significant-Gravitas/Auto-GPT
|
repo_url: https://github.com/Significant-Gravitas/Auto-GPT
|
||||||
|
docs_dir: .
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Setup: setup.md
|
- Setup: setup.md
|