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

docs: added minimal automation docs #144

Merged
merged 1 commit into from
Oct 2, 2024
Merged

Conversation

ErikBjare
Copy link
Owner

@ErikBjare ErikBjare commented Oct 2, 2024

Getting started on #143


Important

Adds minimal automation documentation for gptme, including examples for automated code review and daily activity summaries, and updates Sphinx configuration.

  • Documentation:
    • Adds automation.rst with examples for using gptme in automation, including feature implementation scripts.
    • Includes example_code_review.rst and example_activity_summary.rst for automated code review and daily activity summary.
  • Configuration:
    • Updates conf.py to include the automation section in Sphinx documentation.
  • Misc:
    • Minor formatting changes in conf.py and util.py.

This description was created by Ellipsis for 4af76d7. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 3e495dc in 11 seconds

More details
  • Looked at 288 lines of code in 7 files
  • Skipped 0 files when reviewing.
  • Skipped posting 3 drafted comments based on config settings.
1. docs/automation/example_activity_summary.rst:12
  • Draft comment:
    date -d is not portable across all Unix-like systems. Consider using a more portable solution like date -v-1d for BSD systems or using Python for date manipulation.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The script in example_activity_summary.rst uses date -d which is not portable across all Unix-like systems. It would be better to use a more portable solution.
2. docs/automation/example_code_review.rst:18
  • Draft comment:
    Using xargs curl -s can fail if the URL contains special characters. Consider using curl -sL directly with the URL to avoid potential issues.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The script in example_code_review.rst uses xargs curl -s to fetch the diff, which might fail if the URL contains special characters. It's safer to use curl -sL directly with the URL.
3. docs/automation/example_code_review.rst:62
  • Draft comment:
    Using gh auth login --with-token <<< "${{ secrets.GITHUB_TOKEN }}" can expose the token. Consider using gh auth login with environment variables securely.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In example_code_review.rst, the script directly uses the GitHub token in a potentially insecure way. It's better to use environment variables securely.

Workflow ID: wflow_20NYVuDbnXJmTpbL


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@codecov-commenter
Copy link

codecov-commenter commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.54%. Comparing base (44e76ff) to head (4af76d7).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #144   +/-   ##
=======================================
  Coverage   80.54%   80.54%           
=======================================
  Files          52       52           
  Lines        3156     3156           
=======================================
  Hits         2542     2542           
  Misses        614      614           
Flag Coverage Δ
anthropic/claude-3-haiku-20240307 79.43% <ø> (-0.04%) ⬇️
openai/gpt-4o-mini 79.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on 4af76d7 in 7 seconds

More details
  • Looked at 288 lines of code in 7 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. gptme/util.py:200
  • Draft comment:
    The import statement from .tools import init_tools is unused and can be removed to clean up the code.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The import statement for 'init_tools' in 'util.py' is not used anywhere else in the file. This is unnecessary and should be removed to clean up the code.

Workflow ID: wflow_Z9is49jReZCre0Kv


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@ErikBjare ErikBjare merged commit 3902b86 into master Oct 2, 2024
7 checks passed
@ErikBjare ErikBjare deleted the dev/automation-docs branch October 2, 2024 12:04
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