Skip to content

Commit

Permalink
Generated Docs for "Readme rewrite with references to native SDKs and…
Browse files Browse the repository at this point in the history
… Klaviyo help center (#62)" (#85)

* Link to license file in README (#60)

Co-authored-by: Evan Masseau <>

* Updated readme to include troubleshooting steps when running pod install (#63)

updated readme

* Updating version to 0.1.1 (#66)

* 0.1.1

* updating version

* reverting back to use older rn version

* updating yarn lock

* removing changes to package lock file

* Fixes for React Native Apps <= 0.72.0 (#71)

* Fix the react-native gradle dependency
* Add a local property to enable specifying react-native version for the SDK for local development
* Specify Kotlin version that is compatible with Android SDK's (although this didn't seem to actually cause any build errors)
* Remove accidental use of an extension method that is technically SDK 24+

---------

Co-authored-by: Evan Masseau <>

* Update local.properties template files (#68)

* Add template local.properties file to example app
* Be clearer about VCS status of these files.

---------

Co-authored-by: Evan Masseau <>

* Bump example iOS project lockfile (#74)

I think this needs to be bumped when we increase the overall project version.

Co-authored-by: Evan Masseau <>

* Github CI Updates (#75)

* Move doc bot to its own file so we don't have to see it as skipped all the time.

* Use same ruby version as local dev environment

* Stop using `yarn pod-install` because it creates an erroneous xcode.env.local file that breaks the hermes build scripts.

---------

Co-authored-by: Evan Masseau <>

* Updating to iOS SDK 3.0.2 (#77)

* 0.1.1

* updated to us latest iOS SDK

* removing package lock

* Pod install | static linking issue | RCT Folly | Turbo modules (#70)

* 0.1.1

* removed turbo module stuff and added xcconfig

* removing package lock

* comitting example app pod lock file

---------

Co-authored-by: Evan Masseau <>
Co-authored-by: Evan C Masseau <[email protected]>

* Readme rewrite with references to native SDKs and Klaviyo help center (#62)


---------

Co-authored-by: Evan Masseau <>
Co-authored-by: Kenny Tsui <[email protected]>

* Generated docs for 149cfd8

---------

Co-authored-by: Evan C Masseau <[email protected]>
Co-authored-by: Ajay Subramanya <[email protected]>
Co-authored-by: Kenny Tsui <[email protected]>
Co-authored-by: github-actions <[email protected]>
  • Loading branch information
5 people authored Feb 6, 2024
1 parent 35c8484 commit a6fe1de
Show file tree
Hide file tree
Showing 27 changed files with 539 additions and 339 deletions.
49 changes: 3 additions & 46 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ jobs:

- uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2.2'
ruby-version: '2.6.10'

- name: Setup
uses: ./.github/actions/setup
Expand Down Expand Up @@ -158,54 +158,11 @@ jobs:
- name: Install cocoapods
if: env.turbo_cache_hit != 1 && steps.cocoapods-cache.outputs.cache-hit != 'true'
run: |
yarn pod-install example/ios
brew install watchman
cd example/ios
pod install
env:
NO_FLIPPER: 1

- name: Build example for iOS
run: |
yarn turbo run build:ios --cache-dir="${{ env.TURBO_CACHE_DIR }}"
generate-documentation:
# Only run on master branch push (e.g. after pull request merge).
if: github.event_name == 'push'
runs-on: ubuntu-22.04
env:
CI_COMMIT_MESSAGE: Generated docs for ${{ github.sha }}
GH_TOKEN: ${{ github.token }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: documentation
fetch-depth: 0

- name: Setup
uses: ./.github/actions/setup

- name: Git config
run: |
git config user.name github-actions
git config user.email [email protected]
git fetch origin
- name: Create branch for docs PR
run: |
git checkout -b "documentation-${{ github.sha }}"
git merge origin/master --no-edit --strategy-option theirs
- name: Generate docs
run: |
yarn generate-docs
- name: Commit and push docs
run: |
git add docs
git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
git push -u origin "documentation-${{ github.sha }}"
- name: Create PR for doc updates
run: |
gh pr create --draft --title "Generated Docs for \"$(git show -s --format=%B ${{ github.sha }})\"" --body "This PR was automatically generated by a GitHub Action for ${{ github.sha }}." -B "documentation" -H "documentation-${{ github.sha }}"
57 changes: 57 additions & 0 deletions .github/workflows/doc-bot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: CI

on:
push:
branches:
- master

permissions:
contents: write
pull-requests: write

jobs:

generate-documentation:
runs-on: ubuntu-22.04
env:
CI_COMMIT_MESSAGE: Generated docs for ${{ github.sha }}
GH_TOKEN: ${{ github.token }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: documentation
fetch-depth: 0

- name: Setup
uses: ./.github/actions/setup

- name: Git config
run: |
git config user.name github-actions
git config user.email [email protected]
git fetch origin
- name: Create branch for docs PR
run: |
git checkout -b "documentation-${{ github.sha }}"
git merge origin/master --no-edit --strategy-option theirs
- name: Generate docs
run: |
yarn generate-docs
- name: Commit and push docs
run: |
if [ $(git status -s -uno | wc -l) -eq 0 ]; then
echo "No documentation to change"
exit 0
fi
git add docs
git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
git push -u origin "documentation-${{ github.sha }}"
- name: Create PR for doc updates
run: |
gh pr create --title "Generated Docs for \"$(git show -s --format=%B ${{ github.sha }})\"" --body "This PR was automatically generated by a GitHub Action for ${{ github.sha }}." -B "documentation" -H "documentation-${{ github.sha }}"
Loading

0 comments on commit a6fe1de

Please sign in to comment.