Skip to content

Commit

Permalink
Merge branch 'master' into development
Browse files Browse the repository at this point in the history
  • Loading branch information
sunshinejr committed Mar 2, 2020
2 parents 86f2b1f + 79e05b1 commit 71180ee
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
3 changes: 2 additions & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ let config = PackageConfiguration([
"scripts/update_podspec.sh"
],
"after": [
"rake create_release\\[\"$VERSION\"\\]"
"rake create_release\\[\"$VERSION\"\\]",
"scripts/update_docs_website.sh"
]
]
]).write()
Expand Down
2 changes: 1 addition & 1 deletion docs/Releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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]).
19 changes: 19 additions & 0 deletions scripts/update_docs_website.sh
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

0 comments on commit 71180ee

Please sign in to comment.