Skip to content

Commit

Permalink
Update CONTRIBUTING docs to no longer say that we build amd64 Debian …
Browse files Browse the repository at this point in the history
…ustreamer packages (#1798)

Resolves: #1797 
Related: tiny-pilot/ustreamer-debian#17

This change removes references to amd64 ustreamer Debian package builds
in CircleCI now that CI only uses an ARM executor.

<a data-ca-tag
href="https://codeapprove.com/pr/tiny-pilot/tinypilot/1798"><img
src="https://codeapprove.com/external/github-tag-allbg.png" alt="Review
on CodeApprove" /></a>
  • Loading branch information
db39 authored May 16, 2024
1 parent a444cbd commit cd5bca3
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ curl \

### Build a uStreamer Debian package

CircleCI builds the uStreamer Debian package for both `amd64`- and `armhf`-based architectures on every commit to the [`ustreamer-debian` repo](https://github.com/tiny-pilot/ustreamer-debian), which is stored as a CircleCI artifact.
CircleCI builds the uStreamer Debian package for the `armhf` architecture on every commit to the [`ustreamer-debian` repo](https://github.com/tiny-pilot/ustreamer-debian), which is stored as a CircleCI artifact.

Follow these steps:

Expand All @@ -206,16 +206,14 @@ Follow these steps:
- If the [`build_debian_package` CircleCI job](https://github.com/tiny-pilot/ustreamer-debian/blob/2ace4a1d22a3c9108f5285e3dff0290c60e5b1cf/.circleci/config.yml#L25) fails for some reason, you can manually debug the code in CircleCI by clicking "rerun job with SSH" in the CircleCI dashboard and following their SSH instructions. Remember to cancel the CircleCI job once you're done debugging, in order to reduce CI costs.
1. When the job completes, go to the "Artifacts" tab of the `build_debian_package` job on CircleCI to find the uStreamer Debian packages.

- We use `amd64`-based builds only for testing in CircleCI.
- We use `armhf`-based builds on physical devices.
- We use `armhf`-based builds on physical devices and for testing in CircleCI.
- [Docker platform names don't match Debian architecture names:](https://github.com/tiny-pilot/ustreamer-debian/blob/2ace4a1d22a3c9108f5285e3dff0290c60e5b1cf/Dockerfile#L46C1-L48)

> Docker's platform names don't match Debian's platform names, so we translate
> the platform name from the Docker version to the Debian version...
Which means that when Docker's target platform is:

- `linux/amd64`, CircleCI creates a `amd64` Debian package
- `linux/arm/v7`, CircleCI creates a `armhf` Debian package

### Install a uStreamer Debian package
Expand Down

0 comments on commit cd5bca3

Please sign in to comment.