Setup build CI workflow #1
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| name: Build main (edge) | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| build-and-release-edge: | ||
| name: Build edge release | ||
| runs-on: ubuntu-22.04 | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Export build number as env variable | ||
| run: echo "BUILD_NUMBER=${{ github.run_number }}" >> $GITHUB_ENV | ||
|
|
||
| - name: Extract version | ||
| run: | | ||
| VERSION_FILE="include/nspm-bin-version.h" | ||
|
|
||
| # Use grep to extract the version string from the define statement | ||
| VERSION=$(grep -oP '#define NSPanelManagerFirmwareVersion "\K([^"]+)' $VERSION_FILE) | ||
|
|
||
| # Store the version in an environment variable | ||
| echo "VERSION=$VERSION" >> $GITHUB_ENV | ||
|
|
||
| # Optional: Print version to verify | ||
| echo "Version in environment variable: ${{ env.VERSION }}" | ||
|
|
||
| - name: Replace version in nspm-bin-version.h | ||
| run: | | ||
| echo "FIRMWARE_IDENTIFIER=${{ env.VERSION }}-${{ env.BUILD_NUMBER }}-edge" >> $GITHUB_ENV | ||
| echo "This build will generate firmware identifier ${{ env.FIRMWARE_IDENTIFIER }}" | ||
|
|
||
| - name: Replace version and sha in nspm-bin-version.h | ||
| run: | | ||
| VERSION_FILE="include/nspm-bin-version.h" | ||
|
|
||
| # Replace the version string in the header file using sed | ||
| sed -i 's/#define NSPanelManagerFirmwareVersion ".*"/#define NSPanelManagerFirmwareVersion "${{ env.FIRMWARE_IDENTIFIER }}"/' $VERSION_FILE | ||
| sed -i "s/#define NSPanelManagerFirmwareCommitSha \".*\"/#define NSPanelManagerFirmwareCommitSha \"$GITHUB_SHA\"/" $VERSION_FILE | ||
|
|
||
| cat $VERSION_FILE | ||
| - name: Set up Python | ||
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | ||
| with: | ||
| python-version: '3.12' | ||
| cache: "pipenv" | ||
|
|
||
| - name: Install pipenv | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install pipenv | ||
|
|
||
| - name: Install project required dependencies | ||
| # i.e: platform.io | ||
| run: | | ||
| make install | ||
|
|
||
| - name: Perform pre-commit checks | ||
| # ensure files are correctly formatted, Markdown, yaml, end of file etc. | ||
| run: | | ||
| make pre-commit | ||
|
|
||
| - name: Build firmware.bin | ||
| run: | | ||
| make build-firmware | ||
|
|
||
| - name: Build littlefs.bin | ||
| run: | | ||
| make build-littlefs | ||
|
|
||
| - name: Build AIO (all in one image) | ||
| # includes bootloader + partitions + firmware + littlefs | ||
| # used only the first time an NSPanel is flashed over serial | ||
| # not for OTA updates | ||
| run: | | ||
| make build-aio | ||
|
|
||
| - name: Store firmware .bin as build artifact | ||
| uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 | ||
| with: | ||
| name: firmware-${{ env.FIRMWARE_IDENTIFIER }} | ||
| path: | | ||
| .pio/build/esp32dev/firmware.bin | ||
| .pio/build/esp32dev/firmware.bin.md5 | ||
| .pio/build/esp32dev/littlefs.bin | ||
| .pio/build/esp32dev/littlefs.bin.md5 | ||
| .pio/build/esp32dev/firmware-aio.bin | ||
| .pio/build/esp32dev/firmware-aio.bin.md5 | ||
| retention-days: 1 # Retention policy for 1 day | ||
|
|
||
| - name: Upload firmware.bin to cloudsmith | ||
| uses: cloudsmith-io/action@7af394e0f8add4867bce109385962dafecad1b8d # v0.6.14 | ||
| with: | ||
| api-key: ${{ secrets.CLOUDSMITH_API_KEY }} | ||
| command: "push" | ||
| format: "raw" | ||
| owner: "nspanelmanager" | ||
| repo: "nspanelmanager-firmwares" | ||
| file: ".pio/build/esp32dev/firmware.bin" | ||
| name: "firmware-${{ env.FIRMWARE_IDENTIFIER }}" | ||
| summary: "Edge release of main branch" | ||
| description: "${{ github.sha }}" | ||
| version: ${{ env.FIRMWARE_IDENTIFIER }} | ||
| tags: "experimental, edge, firmware" | ||
|
|
||
| - name: Upload littlefs.bin to cloudsmith | ||
| uses: cloudsmith-io/action@7af394e0f8add4867bce109385962dafecad1b8d # v0.6.14 | ||
| with: | ||
| api-key: ${{ secrets.CLOUDSMITH_API_KEY }} | ||
| command: "push" | ||
| format: "raw" | ||
| owner: "nspanelmanager" | ||
| repo: "nspanelmanager-firmwares" | ||
| file: ".pio/build/esp32dev/littlefs.bin" | ||
| name: "littlefs-${{ env.FIRMWARE_IDENTIFIER }}" | ||
| summary: "Edge release of main branch" | ||
| description: "${{ github.sha }}" | ||
| version: ${{ env.FIRMWARE_IDENTIFIER }} | ||
| tags: "experimental, edge, littlefs" | ||
|
|
||
| - name: Upload firmware-aio.bin to cloudsmith | ||
| uses: cloudsmith-io/action@7af394e0f8add4867bce109385962dafecad1b8d # v0.6.14 | ||
| with: | ||
| api-key: ${{ secrets.CLOUDSMITH_API_KEY }} | ||
| command: "push" | ||
| format: "raw" | ||
| owner: "nspanelmanager" | ||
| repo: "nspanelmanager-firmwares" | ||
| file: ".pio/build/esp32dev/firmware-aio.bin" | ||
| name: "firmware-aio-${{ env.FIRMWARE_IDENTIFIER }}" | ||
| summary: "Edge release of main branch" | ||
| description: "${{ github.sha }}" | ||
| version: ${{ env.FIRMWARE_IDENTIFIER }} | ||
| tags: "experimental, edge, firmware-aio" | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| name: Build PR | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - '**' | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build PR snapshot | ||
| runs-on: ubuntu-22.04 | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Export build number as env variable | ||
| run: echo "BUILD_NUMBER=${{ github.run_number }}" >> $GITHUB_ENV | ||
|
|
||
| - name: Retrieve PR number | ||
| run: echo "PR_NUMBER=${{ github.event.pull_request.number }}" >> $GITHUB_ENV | ||
|
|
||
| - name: Extract version | ||
| run: | | ||
| VERSION_FILE="include/nspm-bin-version.h" | ||
|
|
||
| # Use grep to extract the version string from the define statement | ||
| VERSION=$(grep -oP '#define NSPanelManagerFirmwareVersion "\K([^"]+)' $VERSION_FILE) | ||
|
|
||
| # Store the version in an environment variable | ||
| echo "VERSION=$VERSION" >> $GITHUB_ENV | ||
|
|
||
| # Optional: Print version to verify | ||
| echo "Version in environment variable: ${{ env.VERSION }}" | ||
|
|
||
| - name: Replace version in nspm-bin-version.h | ||
|
Contributor
There was a problem hiding this comment. Same thing here, this step doesn't actually replace the version in the file. |
||
| run: | | ||
| echo "FIRMWARE_IDENTIFIER=${{ env.VERSION }}-${{ env.BUILD_NUMBER }}#PR${{ env.PR_NUMBER }}" >> $GITHUB_ENV | ||
| echo "This build will generate firmware identifier ${{ env.FIRMWARE_IDENTIFIER }}" | ||
|
|
||
| - name: Replace version and sha in nspm-bin-version.h | ||
| run: | | ||
| VERSION_FILE="include/nspm-bin-version.h" | ||
|
|
||
| # Replace the version string in the header file using sed | ||
| sed -i 's/#define NSPanelManagerFirmwareVersion ".*"/#define NSPanelManagerFirmwareVersion "${{ env.FIRMWARE_IDENTIFIER }}"/' $VERSION_FILE | ||
| sed -i "s/#define NSPanelManagerFirmwareCommitSha \".*\"/#define NSPanelManagerFirmwareCommitSha \"$GITHUB_SHA\"/" $VERSION_FILE | ||
|
|
||
| cat $VERSION_FILE | ||
| - name: Set up Python | ||
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | ||
| with: | ||
| python-version: '3.12' | ||
| cache: "pipenv" | ||
|
|
||
| - name: Install pipenv | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install pipenv | ||
|
|
||
| - name: Install project required dependencies | ||
| # i.e: platform.io | ||
| run: | | ||
| make install | ||
|
|
||
| - name: Perform pre-commit checks | ||
| # ensure files are correctly formatted, Markdown, yaml, end of file etc. | ||
| run: | | ||
| make pre-commit | ||
|
|
||
| - name: Build firmware.bin | ||
| run: | | ||
| make build-firmware | ||
|
|
||
| - name: Build littlefs.bin | ||
| run: | | ||
| make build-littlefs | ||
|
|
||
| - name: Build AIO (all in one image) | ||
| # includes bootloader + partitions + firmware + littlefs | ||
| # used only the first time an NSPanel is flashed over serial | ||
| # not for OTA updates | ||
| run: | | ||
| make build-aio | ||
|
|
||
| - name: Store firmware .bin as build artifact | ||
| uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 | ||
| with: | ||
| name: firmware-${{ env.FIRMWARE_IDENTIFIER }} | ||
| path: | | ||
| .pio/build/esp32dev/firmware.bin | ||
| .pio/build/esp32dev/firmware.bin.md5 | ||
| .pio/build/esp32dev/littlefs.bin | ||
| .pio/build/esp32dev/littlefs.bin.md5 | ||
| .pio/build/esp32dev/firmware-aio.bin | ||
| .pio/build/esp32dev/firmware-aio.bin.md5 | ||
| retention-days: 1 # Retention policy for 1 day | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| name: Release | ||
| on: | ||
| release: | ||
| types: [ created, published ] | ||
| jobs: | ||
| publish: | ||
| runs-on: ubuntu-22.04 | ||
| permissions: | ||
| contents: read | ||
| packages: write | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Export build number as env variable | ||
| run: echo "BUILD_NUMBER=${{ github.run_number }}" >> $GITHUB_ENV | ||
|
|
||
| - name: Extract version | ||
| run: | | ||
| VERSION_FILE="include/nspm-bin-version.h" | ||
|
|
||
| # Use grep to extract the version string from the define statement | ||
| VERSION=$(grep -oP '#define NSPanelManagerFirmwareVersion "\K([^"]+)' $VERSION_FILE) | ||
|
|
||
| # Store the version in an environment variable | ||
| echo "VERSION=$VERSION" >> $GITHUB_ENV | ||
|
|
||
| # Optional: Print version to verify | ||
| echo "Version in environment variable: ${{ env.VERSION }}" | ||
|
|
||
| - name: Check release number matches release in code | ||
| run: | | ||
| if [ "${{ env.VERSION }}" != "${{ github.event.release.tag_name }}" ]; then | ||
| echo "Error: The version in the code (${{ env.VERSION }}) does not match the release tag (${{ github.event.release.tag_name }}). Please verify nspm-bin-version.h" | ||
| exit 1 | ||
| fi | ||
| echo "Version matches release tag." | ||
|
|
||
| - name: Replace version in nspm-bin-version.h | ||
|
Contributor
There was a problem hiding this comment. Again, perhaps not the best name. Perhaps "Update workflow firmware identifier" or something like that? |
||
| run: | | ||
| echo "FIRMWARE_IDENTIFIER=${{ env.VERSION }}" >> $GITHUB_ENV | ||
| echo "This build will generate firmware identifier ${{ env.FIRMWARE_IDENTIFIER }}" | ||
|
|
||
| - name: Replace version and sha in nspm-bin-version.h | ||
| run: | | ||
| VERSION_FILE="include/nspm-bin-version.h" | ||
|
|
||
| # Replace the version string in the header file using sed | ||
| sed -i 's/#define NSPanelManagerFirmwareVersion ".*"/#define NSPanelManagerFirmwareVersion "${{ env.FIRMWARE_IDENTIFIER }}"/' $VERSION_FILE | ||
| sed -i "s/#define NSPanelManagerFirmwareCommitSha \".*\"/#define NSPanelManagerFirmwareCommitSha \"$GITHUB_SHA\"/" $VERSION_FILE | ||
|
|
||
| cat $VERSION_FILE | ||
| - name: Set up Python | ||
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | ||
| with: | ||
| python-version: '3.12' | ||
| cache: "pipenv" | ||
|
|
||
| - name: Install pipenv | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install pipenv | ||
|
|
||
| - name: Install project required dependencies | ||
| # i.e: platform.io | ||
| run: | | ||
| make install | ||
|
|
||
| - name: Perform pre-commit checks | ||
| # ensure files are correctly formatted, Markdown, yaml, end of file etc. | ||
| run: | | ||
| make pre-commit | ||
|
|
||
| - name: Build firmware.bin | ||
| run: | | ||
| make build-firmware | ||
|
|
||
| - name: Build littlefs.bin | ||
| run: | | ||
| make build-littlefs | ||
|
|
||
| - name: Build AIO (all in one image) | ||
| # includes bootloader + partitions + firmware + littlefs | ||
| # used only the first time an NSPanel is flashed over serial | ||
| # not for OTA updates | ||
| run: | | ||
| make build-aio | ||
|
|
||
| - name: Store firmware .bin as build artifact | ||
| uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 | ||
| with: | ||
| name: firmware-${{ env.FIRMWARE_IDENTIFIER }} | ||
| path: | | ||
| .pio/build/esp32dev/firmware.bin | ||
| .pio/build/esp32dev/firmware.bin.md5 | ||
| .pio/build/esp32dev/littlefs.bin | ||
| .pio/build/esp32dev/littlefs.bin.md5 | ||
| .pio/build/esp32dev/firmware-aio.bin | ||
| .pio/build/esp32dev/firmware-aio.bin.md5 | ||
| retention-days: 1 # Retention policy for 1 day | ||
|
|
||
| - name: Upload firmware.bin to cloudsmith | ||
| uses: cloudsmith-io/action@7af394e0f8add4867bce109385962dafecad1b8d # v0.6.14 | ||
| with: | ||
| api-key: ${{ secrets.CLOUDSMITH_API_KEY }} | ||
| command: "push" | ||
| format: "raw" | ||
| owner: "nspanelmanager" | ||
| repo: "nspanelmanager-firmwares" | ||
| file: ".pio/build/esp32dev/firmware.bin" | ||
| name: "firmware-${{ env.FIRMWARE_IDENTIFIER }}" | ||
| summary: "Stable release" | ||
| description: "${{ github.sha }}" | ||
| version: ${{ env.FIRMWARE_IDENTIFIER }} | ||
| tags: "stable, firmware" | ||
|
|
||
| - name: Upload littlefs.bin to cloudsmith | ||
| uses: cloudsmith-io/action@7af394e0f8add4867bce109385962dafecad1b8d # v0.6.14 | ||
| with: | ||
| api-key: ${{ secrets.CLOUDSMITH_API_KEY }} | ||
| command: "push" | ||
| format: "raw" | ||
| owner: "nspanelmanager" | ||
| repo: "nspanelmanager-firmwares" | ||
| file: ".pio/build/esp32dev/littlefs.bin" | ||
| name: "littlefs-${{ env.FIRMWARE_IDENTIFIER }}" | ||
| summary: "Stable release" | ||
| description: "${{ github.sha }}" | ||
| version: ${{ env.FIRMWARE_IDENTIFIER }} | ||
| tags: "stable, littlefs" | ||
|
|
||
| - name: Upload firmware-aio.bin to cloudsmith | ||
| uses: cloudsmith-io/action@7af394e0f8add4867bce109385962dafecad1b8d # v0.6.14 | ||
| with: | ||
| api-key: ${{ secrets.CLOUDSMITH_API_KEY }} | ||
| command: "push" | ||
| format: "raw" | ||
| owner: "nspanelmanager" | ||
| repo: "nspanelmanager-firmwares" | ||
| file: ".pio/build/esp32dev/firmware-aio.bin" | ||
| name: "firmware-aio-${{ env.FIRMWARE_IDENTIFIER }}" | ||
| summary: "Stable release" | ||
| description: "${{ github.sha }}" | ||
| version: ${{ env.FIRMWARE_IDENTIFIER }} | ||
| tags: "stable, firmware-aio" | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This step doesn't actually replace the version in the nspm-bin-version.h file. So, this step should be renamed to something more appropriate.