-
Notifications
You must be signed in to change notification settings - Fork 6
docs: weekly architecture docs refresh automation #167
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
base: main
Are you sure you want to change the base?
Conversation
… helper - Add scripts/openhands_api.py minimal client for OpenHands Cloud API - Add scripts/prompts/architecture_refresh.j2 prompt with style/citation/PR requirements - Add .github/workflows/weekly-architecture-refresh.yml to trigger weekly refresh Co-authored-by: openhands <openhands@all-hands.dev>
…n 3.12 Co-authored-by: openhands <openhands@all-hands.dev>
…lpers - Replace urllib with requests - Keep simple _http_json wrapper for consistency, but leverage response.json() Co-authored-by: openhands <openhands@all-hands.dev>
- Use astral-sh/setup-uv and uv run with Python 3.12 - Inline requests Session calls; remove urllib/json glue Co-authored-by: openhands <openhands@all-hands.dev>
…re-agent-sdk under openhands-agent-server/) Co-authored-by: openhands <openhands@all-hands.dev>
…n\nCo-authored-by: openhands <openhands@all-hands.dev>
…oftware-agent-sdk HEAD for audit\n\nCo-authored-by: openhands <openhands@all-hands.dev>
…\n\nCo-authored-by: openhands <openhands@all-hands.dev>
…with correct agent-server path)\n\nCo-authored-by: openhands <openhands@all-hands.dev>
neubig
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this @enyst ! But is there a reason why we need openhands_api.py and couldn't just use the more standard workflow here? https://github.com/OpenHands/software-agent-sdk/tree/main/examples/03_github_workflows/01_basic_action
If there's a reason why you particularly want to run this on the cloud, it might be nice to have a standard "dispatch to cloud" github workflow in the examples directory, and then re-use that here.
This PR adds a weekly workflow that refreshes the SDK architecture documentation using the OpenHands Cloud API, adapted from the ideas in OpenHands/OpenHands#10566.
What’s included
.github/workflows/weekly-architecture-refresh.ymlscripts/openhands_api.pyscripts/prompts/architecture_refresh.j2.github/pull_request_template.md; run pre-commit; ensure CI passesCredentials
OPENHANDS_API_KEYto be set as an Actions secret. If a different secret name is preferred (e.g., ALL_HANDS_BOT), we can adjust the workflow environment variable.Notes
Co-authored-by: openhands openhands@all-hands.dev
@enyst can click here to continue refining the PR