Document releasing process and add SPM limitations

This commit is contained in:
Bartosz Polaczyk
2021-10-15 14:23:54 +02:00
committed by GitHub
parent 0f44da7bea
commit d25b4e0e06
+6
View File
@@ -330,6 +330,7 @@ Head over to our [cocoapods-plugin](cocoapods-plugin/README.md) docs to see how
## Limitations
* Swift Package Manager (SPM) projects are not supported
* Filenames with `_vers.c` suffix are reserved and cannot be used as a source file
* All compilation files should be referenced via the git repo root. Referencing `/AbsolutePath/someOther.swift` or `../../someOther.swift` that resolve to the location outside of the git repo root is prohibited.
@@ -343,6 +344,11 @@ Follow the [Development](docs/Development.md) guide. It has all the information
## Release
To release a version, in [Releases](https://github.com/spotify/XCRemoteCache/releases) draft a new release with `v0.3.0{-rc0}` version format.
Packages with binaries will be automatically uploaded to the GitHub [Releases](https://github.com/spotify/XCRemoteCache/releases) page.
### Building release package
To build a release zip package, call:
```shell