Skip to content

Custom board build#7594

Merged
dhalbert merged 2 commits into
adafruit:mainfrom
microdev1:ci
Feb 16, 2023
Merged

Custom board build#7594
dhalbert merged 2 commits into
adafruit:mainfrom
microdev1:ci

Conversation

@microdev1
Copy link
Copy Markdown
Collaborator

You can now create a custom board build in your fork. 🐍🚀

- upload stubs as `.tar.gz` instead of `.zip`
- append recursive flag only when the source ends with a backslash
@microdev1
Copy link
Copy Markdown
Collaborator Author

Steps: (See: https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow)

  1. Fork the adafruit/circuitpython repository.
  2. Activate GitHub Actions in your fork.
  3. Select "Custom board build" workflow.
  4. Click on "Run workflow".
  5. You will be presented with the following menu.

custom-board-build-menucustom-board-build-menu-dark

Menu:

  • Board:
    • The board_id of the board to build.
    • Can be found in ports/*/boards/[board_id]
  • Version:
    • The version of CircuitPython to build.
    • Can be a tag or a commit. Anything above c8a325a should work but >=8.1.0 is better to communicate.
  • Language:
    • The language of the build.
    • Can be found in locale/[language].po
  • Flags:
    • The flags to use for the build.
    • Example: CIRUITPY_WIFI=1.
  • Debug:
    • Whether or not to make a debug build.
    • Check the box to make a debug build.

The resulting build command executed in the port directory:

make -j2 $FLAGS BOARD=... DEBUG=... TRANSLATION=...

The generated build-*/firmware.* files will be available as an artifact.

Note
The firmware version will have -dirty appended to it if the flags are provided or it is a debug build.

@microdev1
Copy link
Copy Markdown
Collaborator Author

custom-board-buildcustom-board-build-dark

@microdev1
Copy link
Copy Markdown
Collaborator Author

Related to #4552.

@microdev1 microdev1 added this to the 8.1.0 milestone Feb 16, 2023
@dhalbert
Copy link
Copy Markdown
Collaborator

Also fixes main merge builds not being uploaded to AWS S3. (per discord discussion)

Copy link
Copy Markdown
Collaborator

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This may be very helpful for people. We probably really need a Learn Guide page to explain it, bmaybe in the Building CircuitPython Learn Guide.

@dhalbert dhalbert merged commit e47e645 into adafruit:main Feb 16, 2023
@microdev1 microdev1 deleted the ci branch February 16, 2023 15:58
@anecdata anecdata mentioned this pull request Dec 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants