Skip to content

Commit

Permalink
docs: remove non amplitude files from sdk website (#321)
Browse files Browse the repository at this point in the history
* update appledoc plist

* update release.config.js

* fix appledoc interference

* syntax error

* fix formatting
  • Loading branch information
jooohhn authored Jan 9, 2021
1 parent 4f6c937 commit 73365bd
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 17 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,13 @@ jobs:
ref: 'gh-pages'
path: 'Amplitude-iOS-gh-pages'

- name: Install appledoc
- name: Install appledoc binary
run: |
git clone git://github.com/tomaz/appledoc.git
cd appledoc/
sudo sh install-appledoc.sh
cd ../
rm -rf appledoc/
- name: Semantic Release --dry-run
if: ${{ github.event.inputs.dryRun == 'true'}}
Expand Down
33 changes: 18 additions & 15 deletions AppledocSettings.plist
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<dict>
<key>--project-name</key>
<string>Amplitude-iOS</string>
<key>--project-company</key>
<string>Amplitude</string>
<key>--project-company</key>
<string>Amplitude Inc.</string>
<key>--company-id</key>
<string>com.amplitude</string>
<key>--templates</key>
<string>appledoc-templates</string>

<key>--output</key>
<string>documentation</string>
<string>doc</string>

<key>--create-docset</key>
<false/>
Expand All @@ -23,17 +23,20 @@

<key>--ignore</key>
<array>
<string>Pods</string>
<string>documentation</string>
<string>build</string>
<string>AmplitudeTests</string>
<string>AmplitudeFramework</string>
<string>appledoc-templates</string>
<string>*.framework</string>
<string>AMPDatabaseHelper.m</string>
<string>AMPURLConnection.m</string>
<string>SSLCertificatePinning</string>
<string>Pods</string>
<string>documentation</string>
<string>build</string>
<string>AmplitudeTests</string>
<string>AmplitudeFramework</string>
<string>appledoc-templates</string>
<string>*.framework</string>
<string>AMPDatabaseHelper.m</string>
<string>AMPURLConnection.m</string>
<string>SSLCertificatePinning</string>
</array>

</dict>
<key>--exit-threshold</key>
<integer>2</integer>

</dict>
</plist>
2 changes: 1 addition & 1 deletion release.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ module.exports = {
}],
["@semantic-release/exec", {
"publishCmd": "pod trunk push Amplitude.podspec",
"successCmd": "appledoc --exit-threshold 2 --project-name Amplitude --project-company \"Amplitude Inc\" --company-id com.amplitude --no-create-docset --output ./doc/ . && rsync -av doc/html/* Amplitude-iOS-gh-pages/ && cd Amplitude-iOS-gh-pages && git commit -am '${nextRelease.version}' && git push"
"successCmd": "appledoc . && rsync -av doc/html/* Amplitude-iOS-gh-pages/ && cd Amplitude-iOS-gh-pages && git commit -am '${nextRelease.version}' && git push"
}],
],
}

0 comments on commit 73365bd

Please sign in to comment.