feat: update setup script and installation instructions for easier setup#912
feat: update setup script and installation instructions for easier setup#912jaagut wants to merge 4 commits into
Conversation
- Add a workflow that validates the setup script twice a month
209b5c8 to
dd0899c
Compare
There was a problem hiding this comment.
Pull request overview
This PR replaces the legacy one-shot setup script with a new bitbots_setup.sh that has clearer argument handling and better UX around SSH vs HTTPS cloning, and updates user-facing docs and CI to reference the new setup flow.
Changes:
- Added
scripts/bitbots_setup.shwith argument parsing (--ssh/--https+ optional branch), Pixi bootstrapping, and repository clone + build steps. - Updated installation documentation (
README.md, docs tutorial) to use the new setup script and describe SSH/HTTPS behavior. - Added a scheduled GitHub Actions workflow to periodically run the setup script.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/bitbots_misc/bitbots_docs/docs/manual/tutorials/installation.rst | Updates the TLDR install command and prerequisites to use bitbots_setup.sh. |
| scripts/setup.sh | Removes the old setup script. |
| scripts/bitbots_setup.sh | Introduces the new, more robust setup script with argument parsing and Pixi+build automation. |
| README.md | Updates installation instructions and explains SSH/HTTPS options for cloning. |
| .github/workflows/setup-script.yml | Adds scheduled/manual CI to run the setup script periodically. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
This just clones the repo, installes pixi and runs pixi install (why not build?). These are pretty standard steps for a repo like this. I think the setup script made more sense for the whole complicated old setup. While I understand the utility of running a single command that can be referenced at different parts of the docs etc. I am a bit intrigued by the overhead of the relatively big bash file, the risk of some fragile logic (pulling some dep manually for example) that can be easily introduced by a not that experienced person or maybe an agent in the future and the amount of magic it adds for not as experienced people who should at least familiarize themselves slightly with pixi and git. I am not strictly against the script, but we might want to evaluate if it is really nessesay and if e.g. a 3 line quickstart section in the readme is more transparent. |
Summary
This pull request introduces a new, more robust setup script and updates the documentation to streamline and clarify the installation process for the Bit-Bots software stack. The main improvements are the replacement of the old
setup.shscript with a newbitbots_setup.shscript, which provides better argument handling, clearer user interaction, and improved reliability. Documentation and workflow files are updated to reference the new script and reflect the revised installation steps.Proposed changes
Setup Script Improvements:
scripts/bitbots_setup.shscript that provides robust argument parsing, explicit SSH/HTTPS selection, improved error handling, and automatic Pixi installation and workspace build.scripts/setup.shscript, which had less robust logic and less clear user prompts.Documentation Updates:
README.mdto instruct users to use the newbitbots_setup.shscript, clarify prerequisites, and explain SSH/HTTPS options.bitbots_docs/docs/manual/tutorials/installation.rst) to reflect the new script, simplify the installation command, and clarify SSH/HTTPS usage.CI/CD Workflow:
.github/workflows/setup-script.yml) to regularly test the setup script, ensuring its continued reliability.Related issues
Checklist
pixi run build