Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PCM packaging fixes #131

Merged
merged 4 commits into from
Nov 17, 2023
Merged

PCM packaging fixes #131

merged 4 commits into from
Nov 17, 2023

Conversation

JarrettR
Copy link
Contributor

@JarrettR JarrettR commented Nov 1, 2023

When trying to submit this to the official KiCad PCM, the CI pipeline fails. This PR should fix that.

image

  1. Removed spurious / from the metadata filename
  2. Moved extra PCM installation instruction images from resources into docs instead
  3. Updated README to reflect the new image locations

The next release should fix the build zip and we should be able to merge into the PCM

@JarrettR
Copy link
Contributor Author

JarrettR commented Nov 1, 2023

Actually, the work isn't quite done. The CI pipeline wants to validate every version, but will fail for the same reasons on 2.0.0 to 2.0.4. Additionally, here is the more complete error log (of the latest version only):

Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S2-WROOM.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-MINI-1.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S2-WROVER.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-WROVER-E.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-WROOM-32E_No-Cover.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S2-SOLO-U.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S2-MINI-1U.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-C3-MINI-1U.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S3-MINI-1.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-C3-WROOM-02.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S2-MINI-1.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S3-WROOM-1.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S3-WROOM-1U.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-WROOM-32E.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-S2-SOLO.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-C3-MINI-1.STEP"
Version 2.0.4: package contains extra file "3dmodels/espressif.3dshapes/ESP32-C3-WROOM-02U.STEP"
Version 2.0.4: package contains extra file "resources/pcm_install_step-4.png"
Version 2.0.4: package contains extra file "resources/pcm_install_step-2.png"
Version 2.0.4: package contains extra file "resources/pcm_install_step-3.png"
Version 2.0.4: package contains extra file "resources/pcm_install_step-1.png"
Version 2.0.4: package contains extra file "/metadata.json"
Version 2.0.4: package has no metadata.json

Proposal:
Remove the earlier versions from the metadata.json
This is will force users to manually install it as before, with effectively no change. It feels slightly dirty, though, so I don't want to do it myself with no feedback.

I'm not sure about the 3D models at the moment.

@pedrominatel pedrominatel added the enhancement New feature or request label Nov 2, 2023
@pedrominatel pedrominatel added this to the 2.0.5 milestone Nov 2, 2023
@pedrominatel
Copy link
Member

Hi @JarrettR, thank you for your contribution.

We can remove the old versions from the metadata or we can backport the changes, but I don't think this extra work will be needed.
Regarding the extra 3D models, we can remove the STEP files if the WRL is present for the same footprint, but we need to double-check if the WRL file is the one selected for the footprint in the properties.

@pedrominatel pedrominatel self-requested a review November 2, 2023 09:14
@JarrettR
Copy link
Contributor Author

JarrettR commented Nov 2, 2023

Okay, I would expect this one to work on the next release.

I've removed the metadata file as discussed. Your GH action will regenerate it on release.

The other issue is that the KiCad CI pipeline requires 3D models to have a lowercase extensions. Because many of the CAD options seem to prefer uppercase extensions, I submitted a merge request to change that requirement, but it doesn't seem like that will be accepted at this time. So, the STEP extensions in this repo must be lowercase.

@pedrominatel
Copy link
Member

@JarrettR, in order to avoid any confusion with the naming convention, we can change the file names to lowercase on our side. I don't think it will be necessary the MR you proposed.

@JarrettR
Copy link
Contributor Author

JarrettR commented Nov 4, 2023

👍
Reverted that commit

@pedrominatel pedrominatel merged commit a6a1adf into espressif:main Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants