⚠️ WEB5 SWIFT SDK IS CURRENTLY A WIP!⚠️
After cloning this repository, run:
make bootstrap
This will configure the repository's submodules properly, and ensure you're all set to go!
With Swift Package Manager, pre-releases are not necessary as it can directly utilize the repository's revision or branch name. For instance, to test the current version of the Web5 package, you can specify either:
// Use the main branch
.package(url: "https://github.com/TBD54566975/web5-swift.git", .branch("main")),
// Use a specific commit
.package(url: "https://github.com/TBD54566975/web5-swift.git", .revision("915f12ea53efeff3587f2d16d3aeb8c203ae7db4")),To release a new version, initiate the Release workflow:
-
Select the version type:
major,minor,patch, ormanual.- For instance, if the latest version is
0.1.2:majorwill update to1.0.0minorwill update to0.2.0patchwill update to0.1.3- For
manual, input the desired version in the Custom Version field, e.g.,0.9.0
- For instance, if the latest version is
-
The workflow will automatically create a git tag and a GitHub release, including an automated changelog.
API reference documentation is automatically updated and available at https://swiftpackageindex.com/TBD54566975/web5-swift/{latest-version}/documentation/web5 following each release.