feat: update setup script and installation instructions for easier setup#912
Open
jaagut wants to merge 3 commits into
Open
feat: update setup script and installation instructions for easier setup#912jaagut wants to merge 3 commits into
jaagut wants to merge 3 commits into
Conversation
- Add a workflow that validates the setup script twice a month
jaagut
force-pushed
the
feature/setup_workflow
branch
from
209b5c8 to
dd0899c
Compare
Contributor
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.
| echo "Installing dependencies..." | ||
| pixi install | ||
| echo "Running full build..." | ||
| pixi run -e default build --parallel-workers 2 |
Member
Author
There was a problem hiding this comment.
Yes, but colcon's default behavior leads to system crashes/hangs on non-current systems due to memory exhaustion despite the auto-scaling. I am not sure which simple and reliable heuristic we could use here to determine whether to use the flag.
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 file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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