forked from Moya/Moya
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into development
- Loading branch information
Showing
3 changed files
with
22 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ If you see an error command that you do not have registered session, run command | |
```ruby | ||
pod trunk register you@youremailaddress.com | ||
``` | ||
1. Install jazzy `[sudo] gem install jazzy` | ||
|
||
## Release | ||
|
||
|
@@ -45,6 +46,5 @@ What you might need to do manually afterwards: | |
1. Update the instructions for our supported package managers in the Readme to use the release you just made public (e.g. update version numbers if it was a major release). | ||
1. Update Swift/Moya version table if needed. | ||
1. Update the release description in [GitHub releases tab](https://github.com/Moya/Moya/releases/tag). | ||
1. Check if we need to regenerate docs for [moya.github.io](https://github.com/Moya/moya.github.io). | ||
|
||
If anything goes wrong, don't panic! Get in touch with someone else who has released, or [Ash](mailto:[email protected]). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
git clone [email protected]:Moya/moya.github.io.git _moya.github.io | ||
|
||
# These two lines, instead of pure `jazzy -o ...` make sure we consistently produce docs | ||
# Otherwise we would sometimes get empty docs due to some cache bug & new Xcode file response | ||
# Relevant: https://github.com/realm/jazzy/issues/1087 | ||
rm -rf ~/Library/Developer/Xcode/DerivedData/Moya* | ||
jazzy --documentation=docs/*.md -x USE_SWIFT_RESPONSE_FILE=NO -o _moya.github.io | ||
|
||
cd _moya.github.io | ||
|
||
git add . | ||
|
||
git commit -m "Update docs for version $VERSION" | ||
|
||
git push origin HEAD | ||
|
||
cd .. | ||
|
||
rm -rf _moya.github.io |