Skip to content

Commit

Permalink
Update license files and top-level README.md, move test binaries to…
Browse files Browse the repository at this point in the history
… `tests/` directory (#734)

* Update license files

* Move the test binaries to the tests/ directory

* Remove outdated notice from top-level `README.md`
  • Loading branch information
jessebraham authored Jan 29, 2025
1 parent 9a45e19 commit 3c56608
Show file tree
Hide file tree
Showing 14 changed files with 181 additions and 56 deletions.
17 changes: 10 additions & 7 deletions .github/workflows/hil.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
repository:
description: "Owner and repository to test"
required: true
default: 'esp-rs/espflash'
default: "esp-rs/espflash"
branch:
description: "Branch, tag or SHA to checkout."
required: true
Expand All @@ -26,7 +26,6 @@ concurrency:
cancel-in-progress: true
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}


jobs:
build-espflash:
name: Build espflash
Expand Down Expand Up @@ -60,7 +59,13 @@ jobs:
name: ${{ matrix.board.mcu }}${{ matrix.board.freq }}
if: ${{ github.repository_owner == 'esp-rs' }}
needs: build-espflash
runs-on: [self-hosted, linux, x64, "${{ matrix.board.mcu }}${{ matrix.board.freq }}" ]
runs-on:
[
self-hosted,
linux,
x64,
"${{ matrix.board.mcu }}${{ matrix.board.freq }}",
]
strategy:
matrix:
board:
Expand Down Expand Up @@ -97,7 +102,7 @@ jobs:
- name: flash test
env:
ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
ESPFLASH_APP: espflash/resources/apps/${{ matrix.board.mcu }}
ESPFLASH_APP: espflash/tests/data/${{ matrix.board.mcu }}
shell: bash
run: |
result=$(espflash_app/espflash flash --no-skip ${{ env.ESPFLASH_APP }} 2>&1)
Expand Down Expand Up @@ -140,7 +145,7 @@ jobs:
- name: save-image/write-bin test
env:
ESPFLASH_PORT: /dev/serial_ports/${{ matrix.board.mcu }}
ESPFLASH_APP: espflash/resources/apps/${{ matrix.board.mcu }}
ESPFLASH_APP: espflash/tests/data/${{ matrix.board.mcu }}
run: |
result=$(espflash_app/espflash save-image --merge --chip ${{ matrix.board.mcu }} ${{ matrix.board.flag }} ${{ env.ESPFLASH_APP }} app.bin 2>&1)
echo "$result"
Expand All @@ -159,5 +164,3 @@ jobs:
if ! echo "$result" | grep -q "Hello world!"; then
exit 1
fi
212 changes: 169 additions & 43 deletions LICENSE-APACHE

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2022 The Espflash Project Developers
Copyright (c) 2022-2025 The Espflash Project Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Serial flasher utilities for Espressif devices, based loosely on [esptool.py](ht

Supports the **ESP32**, **ESP32-C2/C3/C6**, **ESP32-H2**, **ESP32-P4**, and **ESP32-S2/S3**.

> [!IMPORTANT]
> Espressif considers espflash and cargo-espflash to be feature-complete at this time. This does not mean we will stop maintaining them; contributions are still welcome. However, we do not plan to pursue further development at this point in time.

## [cargo-espflash](./cargo-espflash/)

A cargo extension for flashing Espressif devices.
Expand Down
2 changes: 1 addition & 1 deletion espflash/tests/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Test Resources

This document describes how the test files under `tests/resources` were generated, so that they can be re-generated in the future if needed.
This document describes how the test files under `tests/data` were generated, so that they can be re-generated in the future if needed.

## IDF Bootloader

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file removed espflash/tests/resources/esp32_hal_blinky
Binary file not shown.
Binary file removed espflash/tests/resources/esp32_hal_blinky.bin
Binary file not shown.

0 comments on commit 3c56608

Please sign in to comment.