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

fix(arduino): Arduino IDE build failure #94

Merged
merged 18 commits into from
Mar 6, 2024

Conversation

ZZ-Cat
Copy link
Owner

@ZZ-Cat ZZ-Cat commented Mar 4, 2024

Overview

This Pull Request fixes #93

The Arduino CI workflow is still having problems. However, the extent of these issues are outside the scope of this Pull Request.
The goal of this Pull Request was to fix some typos in the library.properties file, and I have achieved precisely that.

As for the Arduino CI itself, I will keep it disabled for the time being, until I get around to figuring out what the f*** is going on with it. Already, it was bogging me down and I was going down a rabbit hole that lead nowhere.

Details

Some typos in library.properties were found to be the culprit of builds failing in the Arduino IDE.
This Pull Request resolves that. Plus, disables the Arduino CI for the time being.

Additional

All of the badges in the README.md have been re-arranged, with the Build Status flags for both the Arduino IDE and PlatformIO have been re-factored. The Arduino IDE and PlatformIO Build Status badges are fully functional, and indicate whether-or-not their respective CI build check passes.

Currently, I am still having issues with the Arduino CI side of things.
However, as I have repeatedly stated, CRSF for Arduino builds in Arduino IDE v2.3.2 with impunity, despite the Build Status badge saying otherwise.

…ties`

Suspected cause of the Arduino IDE build failure.
@ZZ-Cat ZZ-Cat added the Bug Fix 👋💥🐞 Bug meet swatter! label Mar 4, 2024
@ZZ-Cat ZZ-Cat self-assigned this Mar 4, 2024
@ZZ-Cat ZZ-Cat added 🚨 Blocks Release 🚨 No release is to be made, until this is resolved. Compiler 💻 This happens during compiling/building/verifying Arduino IDE ♾️ This is specific to the Arduino IDE ...in progress 🚧 Development on this is in progress labels Mar 4, 2024
@ZZ-Cat
Copy link
Owner Author

ZZ-Cat commented Mar 4, 2024

Screenshot_20240305-112140_GitHub.jpg
Screenshot_20240305-112159_GitHub.jpg

=/)/.-=
F*** sake! Did I break the entire workflow chain on the maintenance branch, last night?

By now, it should ha e already started running the checks, instead of it waiting indefinitely like this.

@ZZ-Cat
Copy link
Owner Author

ZZ-Cat commented Mar 5, 2024

Finally! My workflow automations are working. =^/.^=

@ZZ-Cat
Copy link
Owner Author

ZZ-Cat commented Mar 6, 2024

This is very strange. 🤔
I was able to test my last commit to this Pull Request in Arduino IDE v2.3.2 with the following steps:

  1. Checkout the topic branch;
  2. Clone CRSF for Arduino, and save it to my downloads folder;
  3. In Arduino IDE, go to Sketch -> Include Library -> Add .ZIP Library...;
  4. Click CRSForArduino-broken-arduino-ide-build.zip and Arduino IDE installed it;
  5. File -> Examples -> CRSFforArduino -> rc_channels;
  6. Click Verify;

...and everything passed with flying colours.

I don't know why the Arduino CI build is failing here. This may need further investigation.
For now, it might be best for me to keep my Arduino CI disabled for the time being. I have split the other parts of that CI (IE the format check) up and put them into a separate workflow file. So, it's the Arduino build that will be turned off, and I may bog myself down with it at a later date. Because I set out to fix some typos that were in the library.properties file, which was the reason why some people were having trouble getting Version 1.0.0 to work with the Arduino IDE, and I have achieved precisely that.

Now, the Arduino CI failure is actually outside the scope of this Pull Request.
I had erroneously assumed that, because the Arduino CI was failing, that translated to builds within the Arduino IDE itself failing. Throughout my tests tonight, I have proven this assumption wrong.

I have concluded this Pull Request, and I will merge it into the maintenance branch. Then, make a cut of Version 1.0.1 off of it, tomorrow.

@ZZ-Cat ZZ-Cat linked an issue Mar 6, 2024 that may be closed by this pull request
ZZ-Cat added 11 commits March 7, 2024 09:02
This is still being problematic! Therefore, I am disabling it for the time being, until I allocate some time later on down the track to fix this up.
Relative links broke the badges
Let's see whether-or-not they will display their respective statuses now.
I `MAY` need to temporarily re-enable the `arduinoide_build.yml` file in order for this to do its thing.
This should make things look a little more presentable
@ZZ-Cat
Copy link
Owner Author

ZZ-Cat commented Mar 6, 2024

Right-oh. This is practically ready-to-go.
While I am waiting for the PlatfformIO check to finish, I will go ahead and review my changes, and ensure nothing is amiss.

Once the build passes, I will merge this Pull Request into the Version 1.0.x Maintenance Branch.
Then, cut Version 1.0.1 and release it.

@ZZ-Cat ZZ-Cat marked this pull request as ready for review March 6, 2024 21:12
@ZZ-Cat ZZ-Cat merged commit c26e139 into 1.0.x-Maintenance-Branch Mar 6, 2024
2 checks passed
@ZZ-Cat ZZ-Cat deleted the broken-arduino-ide-build branch March 6, 2024 21:18
@ZZ-Cat ZZ-Cat removed the ...in progress 🚧 Development on this is in progress label Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Arduino IDE ♾️ This is specific to the Arduino IDE 🚨 Blocks Release 🚨 No release is to be made, until this is resolved. Bug Fix 👋💥🐞 Bug meet swatter! Compiler 💻 This happens during compiling/building/verifying
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Arduino IDE builds are broken
1 participant