search

wolfSSL / Arduino-wolfSSL

This repository is a restructured copy of https://github.com/wolfSSL/wolfssl/ for the Arduino environment. Any Pull Requests for code changes should be opened there.
https://www.wolfssl.com
GNU General Public License v2.0
11 stars 7 forks source link

wolfSSL 5.6.6-Arduino.2 update #5

Closed gojimmypi closed 5 months ago

gojimmypi commented 5 months ago

Overview

This PR assembles a second v5.6.6 post-release snapshot 5.6.6-Arduino.2 of wolfssl including changes in https://github.com/wolfSSL/wolfssl/pull/7304.

Addresses https://github.com/wolfSSL/Arduino-wolfSSL/issues/4, https://github.com/wolfSSL/wolfssl/issues/6360, https://github.com/arduino/library-registry/pull/4056#issuecomment-1947527696, https://github.com/onelife/Arduino_wolfssl/issues/1.

Background

The files here were restructured with the wolfssl-arduino.sh script located in IDE/ARDUINO (see update).

Reminder: Why restructure and exclude files? See https://github.com/wolfSSL/Arduino-wolfSSL/pull/1 and https://github.com/arduino/arduino-cli/issues/631.

Update Process

For reference, the clone of this fork is located in my C:\workspace\Arduino-wolfSSL-gojimmypi and I used WSL.

Here are the steps I used:

# The script runs from wolfSSL in the IDE/ARDUINO directory.
cd /mnt/c/workspace/wolfssl-$USER-PR/IDE/ARDUINO

# Remove any wolfssl temp directory in ./IDE/ARDUINO
rm -rf ./wolfssl

# This publishing operation is an append:
# Consider removing all files from target `Arduino-wolfSSL` (except `.git` directory)

# Restructure the wolfSSL files into an Arduino-specific library format and contents (excludes non C files)
./wolfssl-arduino.sh INSTALL /mnt/c/workspace/Arduino-wolfSSL-$USER

# (Push the changes, create this PR)

Testing

Remove any existing wolfSSL Arduino library. Install and check examples. Testing performed like this:

# Delete the existing Arduino library.
rm -rf /mnt/c/Users/$USER/Documents/Arduino/libraries/wolfssl

# Remove any wolfssl temp directory in ./IDE/ARDUINO
rm -rf ./wolfssl

# Install wolfSSL Arduino Library.
./wolfssl-arduino.sh INSTALL

# See new examples

Arduino IDE Notes

Acceptance of this PR does not automatically generate an Arduino Library version update. See the Library Registry FAQ.

Once an Arduino Release is created, there will be two new examples in the Arduino IDE:

File - Examples - wolfssl

See the bottom of the list in the Examples from Custom Libraries section:

image

Additional Information

See also the full wolfSSL with Arduino documentation.

Log: https://downloads.arduino.cc/libraries/logs/github.com/wolfSSL/Arduino-wolfSSL/

gojimmypi commented 5 months ago

Hi @dgarske - I've created a draft Arduino release for wolfSSL 5.6.6-Arduino.2

https://github.com/wolfSSL/Arduino-wolfSSL/releases

Ok to publish?

dgarske commented 5 months ago

Hi @dgarske - I've created a draft Arduino release for wolfSSL 5.6.6-Arduino.2

https://github.com/wolfSSL/Arduino-wolfSSL/releases

Ok to publish?

YES