Skip to content

Commit e091fc9

Browse files
committed
Rename Rev_1_0 to USB HW Rev and Rev_0_3 to Legacy HW Rev in workflows and documentation also rename corresponding folders
1 parent 18c5c58 commit e091fc9

28 files changed

+139
-139
lines changed

.github/workflows/build_sw.yml

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ jobs:
2929
- name: Init submodules to get tinyUSB stack
3030
run: ls && cd pico-sdk && git submodule update --init && cd ..
3131

32-
- name: Configure and run CMake for Hardware Rev 0.3
33-
run: cmake -B ${{github.workspace}}/Software/build-Rev-0_3 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-0_3
32+
- name: Configure and run CMake for Legacy Hardware Revision
33+
run: cmake -B ${{github.workspace}}/Software/build-Legacy -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Legacy
3434

35-
- name: Build for Hardware Rev 0.3
36-
run: cmake --build ${{github.workspace}}/Software/build-Rev-0_3 --config ${{env.BUILD_TYPE}}
35+
- name: Build for Legacy Hardware Revision
36+
run: cmake --build ${{github.workspace}}/Software/build-Legacy --config ${{env.BUILD_TYPE}}
3737

38-
- name: Configure and run CMake for Hardware Rev 1.0
39-
run: cmake -B ${{github.workspace}}/Software/build-Rev-1_0 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-1_0
38+
- name: Configure and run CMake for USB Hardware Revision
39+
run: cmake -B ${{github.workspace}}/Software/build-USB -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-USB
4040

41-
- name: Build for Hardware Rev 1.0
42-
run: cmake --build ${{github.workspace}}/Software/build-Rev-1_0 --config ${{env.BUILD_TYPE}}
41+
- name: Build for USB Hardware Revision
42+
run: cmake --build ${{github.workspace}}/Software/build-USB --config ${{env.BUILD_TYPE}}

.github/workflows/pcb_render.yml

+34-34
Original file line numberDiff line numberDiff line change
@@ -16,96 +16,96 @@ jobs:
1616
- name: Check out the repo
1717
uses: actions/checkout@v4
1818

19-
- name: Render PCB image and .mp4 (Rev 1.0)
19+
- name: Render PCB image and .mp4 (USB Hardware Revision)
2020
uses: linalinn/kicad-render@main
2121
with:
22-
pcb_file: KiCad/Rev_1_0/RP2040-Decoder.kicad_pcb
23-
output_path: ${{ github.workspace }}/images_rev_1_0
22+
pcb_file: KiCad/USB/RP2040-Decoder.kicad_pcb
23+
output_path: ${{ github.workspace }}/images_USB
2424
animation: mp4
2525

26-
- name: Render PCB image and .mp4 (Rev 0.3)
26+
- name: Render PCB image and .mp4 (Legacy Hardware Revision)
2727
uses: linalinn/kicad-render@main
2828
with:
29-
pcb_file: KiCad/Rev_0_3/RP2040-Decoder.kicad_pcb
30-
output_path: ${{ github.workspace }}/images_rev_0_3
29+
pcb_file: KiCad/Legacy/RP2040-Decoder.kicad_pcb
30+
output_path: ${{ github.workspace }}/images_Legacy
3131
animation: mp4
3232

33-
- name: Upload images and mp4 as artifact (Rev 1.0)
33+
- name: Upload images and mp4 as artifact (USB Hardware Revision)
3434
uses: actions/upload-artifact@v4
3535
with:
36-
name: pcb-images_rev_1_0
37-
path: images_rev_1_0/
36+
name: pcb-images_USB
37+
path: images_USB/
3838

39-
- name: Upload images and mp4 as artifact (Rev 0.3)
39+
- name: Upload images and mp4 as artifact (Legacy Hardware Revision)
4040
uses: actions/upload-artifact@v4
4141
with:
42-
name: pcb-images_rev_0_3
43-
path: images_rev_0_3/
42+
name: pcb-images_Legacy
43+
path: images_Legacy/
4444

4545
deploy-pages-main:
4646
if: github.ref == 'refs/heads/main' # Only deploy on 'main' branch
4747
runs-on: ubuntu-latest
4848
needs: render-images
4949

5050
steps:
51-
- name: Download pcb-images_rev_1_0 artifact
51+
- name: Download pcb-images_USB artifact
5252
uses: actions/download-artifact@v4
5353
with:
54-
name: pcb-images_rev_1_0
55-
path: images_rev_1_0/
54+
name: pcb-images_USB
55+
path: images_USB/
5656

57-
- name: Download pcb-images_rev_0_3 artifact
57+
- name: Download pcb-images_Legacy artifact
5858
uses: actions/download-artifact@v4
5959
with:
60-
name: pcb-images_rev_0_3
61-
path: images_rev_0_3/
60+
name: pcb-images_Legacy
61+
path: images_Legacy/
6262

6363
- name: Deploy
6464
uses: peaceiris/actions-gh-pages@v3
6565
with:
6666
github_token: ${{ secrets.GITHUB_TOKEN }}
67-
publish_dir: ./images_rev_1_0
67+
publish_dir: ./images_USB
6868
publish_branch: gh-pages # Specify the target branch (gh-pages in this case)
69-
destination_dir: img_rev_1_0
69+
destination_dir: img_USB
7070

7171
- name: Deploy
7272
uses: peaceiris/actions-gh-pages@v3
7373
with:
7474
github_token: ${{ secrets.GITHUB_TOKEN }}
75-
publish_dir: ./images_rev_0_3
75+
publish_dir: ./images_Legacy
7676
publish_branch: gh-pages # Specify the target branch (gh-pages in this case)
77-
destination_dir: img_rev_0_3
77+
destination_dir: img_Legacy
7878

7979
deploy-pages-dev:
8080
if: github.ref == 'refs/heads/dev' # Only deploy on 'dev' branch
8181
runs-on: ubuntu-latest
8282
needs: render-images
8383

8484
steps:
85-
- name: Download pcb-images_rev_1_0 artifact
85+
- name: Download pcb-images_USB artifact
8686
uses: actions/download-artifact@v4
8787
with:
88-
name: pcb-images_rev_1_0
89-
path: images_rev_1_0/
88+
name: pcb-images_USB
89+
path: images_USB/
9090

91-
- name: Download pcb-images_rev_0_3 artifact
91+
- name: Download pcb-images_Legacy artifact
9292
uses: actions/download-artifact@v4
9393
with:
94-
name: pcb-images_rev_0_3
95-
path: images_rev_0_3/
94+
name: pcb-images_Legacy
95+
path: images_Legacy/
9696

97-
- name: Deploy Rev 1.0
97+
- name: Deploy USB Hardware Revision
9898
uses: peaceiris/actions-gh-pages@v3
9999
with:
100100
github_token: ${{ secrets.GITHUB_TOKEN }}
101-
publish_dir: ./images_rev_1_0
101+
publish_dir: ./images_USB
102102
publish_branch: gh-pages-dev # Specify the target branch (gh-pages-dev in this case)
103-
destination_dir: img_rev_1_0
103+
destination_dir: img_USB
104104

105-
- name: Deploy Rev 0.3
105+
- name: Deploy Legacy Hardware Revision
106106
uses: peaceiris/actions-gh-pages@v3
107107
with:
108108
github_token: ${{ secrets.GITHUB_TOKEN }}
109-
publish_dir: ./images_rev_0_3
109+
publish_dir: ./images_Legacy
110110
publish_branch: gh-pages-dev # Specify the target branch (gh-pages-dev in this case)
111-
destination_dir: img_rev_0_3
111+
destination_dir: img_Legacy

.github/workflows/prerelease.yml

+33-33
Original file line numberDiff line numberDiff line change
@@ -24,35 +24,35 @@ jobs:
2424
- name: Init submodules to get tinyUSB stack
2525
run: ls && cd pico-sdk && git submodule update --init && cd ..
2626

27-
- name: Configure and run CMake for Hardware Rev 0.3
27+
- name: Configure and run CMake for Legacy Hardware Revision
2828
# Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
2929
# See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
30-
run: cmake -B ${{github.workspace}}/Software/build-Rev-0_3 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-0_3
30+
run: cmake -B ${{github.workspace}}/Software/build-Legacy -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Legacy
3131

32-
- name: Build for Hardware Rev 0.3
32+
- name: Build for Legacy Hardware Revision
3333
# Build your program with the given configuration
34-
run: cmake --build ${{github.workspace}}/Software/build-Rev-0_3 --config ${{env.BUILD_TYPE}}
34+
run: cmake --build ${{github.workspace}}/Software/build-Legacy --config ${{env.BUILD_TYPE}}
3535

36-
- name: Configure and run CMake for Hardware Rev 1.0
36+
- name: Configure and run CMake for USB Hardware Revision
3737
# Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
3838
# See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
39-
run: cmake -B ${{github.workspace}}/Software/build-Rev-1_0 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-1_0
39+
run: cmake -B ${{github.workspace}}/Software/build-USB -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-USB
4040

41-
- name: Build for Hardware Rev 1.0
41+
- name: Build for Hardware for USB Hardware Revision
4242
# Build your program with the given configuration
43-
run: cmake --build ${{github.workspace}}/Software/build-Rev-1_0 --config ${{env.BUILD_TYPE}}
43+
run: cmake --build ${{github.workspace}}/Software/build-USB --config ${{env.BUILD_TYPE}}
4444

45-
- name: Upload build files as artifact Rev 0.3
45+
- name: Upload build files as artifact for Legacy Hardware Revision
4646
uses: actions/upload-artifact@v4
4747
with:
48-
name: build_files_Rev-0_3
49-
path: ${{github.workspace}}/Software/build-Rev-0_3
48+
name: build_files_Legacy
49+
path: ${{github.workspace}}/Software/build-Legacy
5050

51-
- name: Upload build files as artifact Rev 1.0
51+
- name: Upload build files as artifact for USB Hardware Revision
5252
uses: actions/upload-artifact@v4
5353
with:
54-
name: build_files_Rev-1_0
55-
path: ${{github.workspace}}/Software/build-Rev-1_0
54+
name: build_files_USB
55+
path: ${{github.workspace}}/Software/build-USB
5656

5757
generate-fabrication-files:
5858
runs-on: ubuntu-latest
@@ -74,14 +74,14 @@ jobs:
7474
- name: Run fab toolkit CLI
7575
run: |
7676
cd Fabrication-Toolkit
77-
python3 -m plugins.cli -p ../KiCad/Rev_1_0/RP2040-Decoder.kicad_pcb --autoTranslate --autoFill
77+
python3 -m plugins.cli -p ../KiCad/USB/RP2040-Decoder.kicad_pcb --autoTranslate --autoFill
7878
cd ..
7979
8080
- name: Upload Artifact
8181
uses: actions/upload-artifact@v4
8282
with:
83-
name: fab_outputs_rev_1_0
84-
path: ./KiCad/Rev_1_0/production
83+
name: fab_outputs_USB
84+
path: ./KiCad/USB/production
8585

8686
prerelease:
8787
runs-on: ubuntu-latest
@@ -93,39 +93,39 @@ jobs:
9393
- name: Download fabrication outputs artifact
9494
uses: actions/download-artifact@v4
9595
with:
96-
name: fab_outputs_rev_1_0
97-
path: fab_outputs_rev_1_0
96+
name: fab_outputs_USB
97+
path: fab_outputs_USB
9898

99-
- name: Download build files artifact for Rev 0.3
99+
- name: Download build files artifact for Legacy Hardware Revision
100100
uses: actions/download-artifact@v4
101101
with:
102-
name: build_files_Rev-0_3
103-
path: build_files_Rev-0_3
102+
name: build_files_Legacy
103+
path: build_files_Legacy
104104

105-
- name: Download build files artifact for Rev 1.0
105+
- name: Download build files artifact for USB Hardware Revision
106106
uses: actions/download-artifact@v4
107107
with:
108-
name: build_files_Rev-1_0
109-
path: build_files_Rev-1_0
108+
name: build_files_USB
109+
path: build_files_USB
110110

111111
- name: ls
112112
run: ls
113113

114114
- name: Zip fabrication outputs
115-
run: zip -r FABRICATION_OUTPUTS-REV-1_0.zip fab_outputs_rev_1_0
115+
run: zip -r FABRICATION_OUTPUTS-USB.zip fab_outputs_USB
116116

117-
- name: Zip Rev 0.3 build files
118-
run: zip -r SW_BUILD-REV-0_3.zip build_files_Rev-0_3
117+
- name: Zip SW_BUILD-Legacy files
118+
run: zip -r SW_BUILD-Legacy.zip build_files_Legacy
119119

120-
- name: Zip Rev 1.0 build files
121-
run: zip -r SW_BUILD-REV-1_0.zip build_files_Rev-1_0
120+
- name: Zip SW_BUILD-USB files
121+
run: zip -r SW_BUILD-USB.zip build_files_USB
122122

123123
- name: Release
124124
uses: softprops/action-gh-release@v2
125125
if: startsWith(github.ref, 'refs/tags/')
126126
with:
127127
prerelease: true
128128
files: |
129-
SW_BUILD-REV-0_3.zip
130-
SW_BUILD-REV-1_0.zip
131-
FABRICATION_OUTPUTS-REV-1_0.zip
129+
SW_BUILD-Legacy.zip
130+
SW_BUILD-USB.zip
131+
FABRICATION_OUTPUTS-USB.zip

0 commit comments

Comments
 (0)