Skip to content

Commit c8436f5

Browse files
committed
Update README publishing steps
1 parent beca56b commit c8436f5

File tree

1 file changed

+3
-47
lines changed

1 file changed

+3
-47
lines changed

README.md

Lines changed: 3 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -30,53 +30,9 @@ let addressInfo = try wallet.getAddress(addressIndex: AddressIndex.new)
3030
If you are a maintainer of this project or want to build and publish this project to your
3131
own Github repository use the following steps:
3232

33-
1. Clone this repository and init and update it's [`bdk-ffi`] submodule.
34-
```shell
35-
git clone https://github.com/bitcoindevkit/bdk-swift
36-
git submodule update --init
37-
```
38-
39-
1. Follow the "General" `bdk-ffi` ["Getting Started (Developer)"] instructions.
40-
41-
1. Install the latest version of [Xcode], download and install the advanced tools.
42-
43-
1. Ensure Swift is installed.
44-
45-
1. Install required targets.
46-
```shell
47-
rustup target add aarch64-apple-ios x86_64-apple-ios
48-
rustup target add aarch64-apple-ios-sim --toolchain nightly
49-
rustup target add aarch64-apple-darwin x86_64-apple-darwin
50-
```
51-
52-
1. Build [`bdk-ffi`] Swift bindings and `bdkFFI.xcframework.zip`.
53-
```shell
54-
./build.sh
55-
```
56-
57-
1. Update the `Package.swift` file with the new expected URL for the
58-
`bdkFFI.xcframework.zip` file and new hash as shown at the end of the build.sh script.
59-
For example:
60-
```swift
61-
.binaryTarget(
62-
name: "bdkFFI",
63-
url: "https://github.com/bitcoindevkit/bdk-swift/releases/download/0.1.3/bdkFFI.xcframework.zip",
64-
checksum: "c0b1e3ea09376b3f316d7d83575e1cd513fc4ad39ef8cf01120a3a1d7757fb97"),
65-
```
66-
1. Commit the changed `Package.swift` and tag it with the new version number.
67-
```shell
68-
git add Package.swift
69-
git commit -m "Bump version to 0.1.3"
70-
git tag 0.1.3 -m "Release 0.1.3"
71-
git push --tags
72-
```
73-
74-
1. Create a github release for your new tag.
75-
76-
1. Upload the newly created zip to the new github release and publish the release.
77-
78-
1. Test the new package in Xcode. If you get an error you might need to reset the Xcode
79-
package caches: File -> Packages -> Reset Package Caches.
33+
1. If it doesn't already exist, create a new `release/0.MINOR` branch from the `master` branch
34+
2. Run the `publish-spm` workflow on Github for branch `release/0.MINOR` and version `0.MINOR.0`
35+
3. Copy the changelog from corresponding `bdk-ffi` release description to this release
8036

8137
[Swift]: https://developer.apple.com/swift/
8238
[Xcode]: https://developer.apple.com/documentation/Xcode

0 commit comments

Comments
 (0)