Replace ad hoc build system #6
Merged
Conversation
This file contains 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
apljungquist
commented
May 27, 2024
apljungquist
force-pushed
the
replace_ad_hoc_build_system
branch
from
409e871
to
452583a
Compare
apljungquist
force-pushed
the
replace_ad_hoc_build_system
branch
2 times, most recently
from
569c65c
to
122ce64
Compare
This is modelled after the corresponding changes in `acap-rs` and the motivation is largely the same; in summary it makes it easier to share improvements since we don't need to patch `Makefile`s that may have diverged, and allows more sophisticated integration with Cargo such as getting the name of test binaries build or using build scripts to prepare additional files dynamically. Enumerate workflows in readme This gives potential users a preview of what is available without downloading or installing anything.
* Remove wget dependency Since curl is already installed, wget is unnecessary. * Use regular (non-slim) debian as base, to include man pages, etc. * Install cargo-acap-sdk in Dockerfile * Use --no-docker with cargo-acap-sdk * Merge install_rust.sh into Dockerfile, skip adding unnecessary write permissions * Add devcontainer.json, move Dockerfile into .devcontainer * Install rust-analyzer extension in vscode devcontainers * Add devcontainers configuration to dependabot.yml * Add GitHub CLI as a devcontainer feature
apljungquist
force-pushed
the
replace_ad_hoc_build_system
branch
from
eb57495
to
78ef717
Compare
apljungquist
force-pushed
the
replace_ad_hoc_build_system
branch
from
78ef717
to
a129d88
Compare
In general files have been copied or updated from acap-rs commit 5148b09e77e321a215a18f2f4ab75ec64839265c; if a decision is not explained here it may be explained in the history of acap-rs. `.devcontainer/Dockerfile`: - Inline shell scripts because when copied from a windows host they sometimes fail depending on how git is configured to handle line endings. - Install development tools from acap-rs earlier because we can and when `rust-toolchain.toml` has been removed cargo complains that no version is selected. `.github/workflows/CI.yml`: - Run tests using devcontainer to make sure that the recommended workflow is working. `Makefile`: - Replace default goal since the `help` goal does not exist and as long as `mkhelp` is a python package I don't intend to add it back. - Skip the bulk operations because this template is set up for developing a single app/package. `README.md`: - Remove documentation of development environments other than the dev container because the template is meant to get started quickly and committed or experienced users should be able to set up their own project with this template and acap-rs as inspiration. These environment setups are documented in acap-rs anyway. At some point running `cargo-acap-sdk` on host may become supported, but not before containerized builds a `cargo-acap` and `cross` is added to it. - Add help outputs from various tools to give users a preview of what to expect if they do use the template and to spread awareness of these tools. - Remove the troubleshooting section since this problem should not happen now that shell scripts have been inlined in the `Dockerfile`. `src/main.rs`: - Add a simple test so that `make test` does something interesting out of the box.
apljungquist
force-pushed
the
replace_ad_hoc_build_system
branch
from
a129d88
to
848eb1b
Compare
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.
This is modelled after the corresponding changes in
acap-rsand themotivation is largely the same; in summary it makes it easier to share
improvements since we don't need to patch
Makefiles that may havediverged, and allows more sophisticated integration with Cargo such as
getting the name of test binaries build or using build scripts to
prepare additional files dynamically.
Enumerate workflows in readme
This gives potential users a preview of what is available without
downloading or installing anything.