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 docs #1317

Merged
merged 4 commits into from
Nov 11, 2024
Merged

Update docs #1317

merged 4 commits into from
Nov 11, 2024

Conversation

skudasov
Copy link
Collaborator

@skudasov skudasov commented Nov 11, 2024


Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes improve documentation, streamline the cleanup process, and update Docker commands for better resource management. A new section on component cleanup has been introduced, clarifying the cleanup process and its importance for test environments. The removal of the Docker section simplifies resource management documentation. Additionally, adjustments in various files enhance clarity and provide more detailed guidance for users.

What

  • book/src/SUMMARY.md
    • Added a new entry for "Components Cleanup".
    • Removed the "Docker" section.
  • book/src/framework/components/cleanup.md (new file)
    • Introduced documentation on managing state and cleanup in testing environments.
  • book/src/framework/docker.md (file removed)
    • Removed documentation specific to Docker cleanup, likely consolidated into the new cleanup section.
  • book/src/framework/first_test.md
    • Updated a reference to container removal, directing readers to the new cleanup section.
  • book/src/framework/getting_started.md
    • Improved the guidance on creating and sourcing the .envrc file.
  • book/src/overview.md
    • Updated the introduction to reflect the broader utility of the Chainlink Testing Framework.
  • framework/.changeset/v0.2.1.md (new file)
    • Summarized changes including the addition of upgrade tests, cleanup section, new Chainlink images, and a fix related to cleanup.
  • framework/cmd/docker.go
    • Refactored Docker commands to improve cleanup functionality.
  • framework/cmd/interactive.go
    • Improved error handling and messaging for Docker resource cleanup.
  • framework/cmd/main.go
    • Added a new command for cleaning up all Docker resources.
  • framework/examples/myproject/.envrc
    • Updated environment variables related to logging and testing configurations.
  • framework/examples/myproject/chaos_test.go
    • Enhanced chaos testing scenarios and documentation.
  • framework/examples/myproject/go.mod & go.sum
    • Updated dependencies, reflecting new versions and packages.

@cl-sonarqube-production
Copy link

@skudasov skudasov merged commit 0e411f1 into main Nov 11, 2024
50 of 53 checks passed
@skudasov skudasov deleted the golden-tests branch November 11, 2024 15:26
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