-
-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1855378
commit 087fc43
Showing
39 changed files
with
9,971 additions
and
369 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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Docs build check | ||
env: | ||
YARN_ENABLE_HARDENED_MODE: 0 | ||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- '.github/workflows/docs-check.yml' | ||
- docs/** | ||
pull_request: | ||
paths: | ||
- '.github/workflows/docs-check.yml' | ||
- docs/** | ||
jobs: | ||
build: | ||
if: github.repository == 'AppAndFlow/react-native-safe-area-context' | ||
runs-on: ubuntu-latest | ||
env: | ||
WORKING_DIRECTORY: docs | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Use Node.js 20.x | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: 20.x | ||
- name: Install docs deps | ||
working-directory: ${{ env.WORKING_DIRECTORY }} | ||
run: yarn install | ||
- name: Build docs | ||
working-directory: ${{ env.WORKING_DIRECTORY }} | ||
run: yarn build |
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,31 @@ | ||
name: Docs publish | ||
on: | ||
push: | ||
branches: | ||
- main | ||
- docs | ||
paths: | ||
- docs/** | ||
|
||
jobs: | ||
publish: | ||
if: github.repository == 'AppAndFlow/react-native-safe-area-context' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Check out | ||
uses: actions/checkout@v4 | ||
|
||
- name: Generate awesome content | ||
run: >- | ||
git config --local user.email "action@github.com" | ||
&& git config --local user.name "GitHub Action" | ||
&& cd docs | ||
&& yarn | ||
&& yarn build | ||
- name: Publish generated content to GitHub Pages | ||
uses: JamesIves/github-pages-deploy-action@releases/v3 | ||
with: | ||
FOLDER: docs/build | ||
BRANCH: gh-pages | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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
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 |
---|---|---|
@@ -1,61 +1,3 @@ | ||
# Contributing | ||
|
||
## Development workflow | ||
|
||
### Install dependencies | ||
|
||
Use yarn to install development dependencies. | ||
|
||
```sh | ||
yarn install | ||
``` | ||
|
||
If you don't have bundler installed: | ||
|
||
``` | ||
gem install bundler | ||
``` | ||
|
||
Move to the `example` directory and install dependencies there too. | ||
|
||
```sh | ||
cd example | ||
yarn install | ||
bundle install | ||
``` | ||
|
||
```sh | ||
cd ios && bundle exec pod install | ||
``` | ||
|
||
### Example app | ||
|
||
Start the example app to test your changes. You can use one of the following commands from the repo root, depending on the platform you want to use. | ||
|
||
From the `example` directory: | ||
|
||
#### iOS | ||
|
||
```sh | ||
yarn ios | ||
``` | ||
|
||
I also recommend opening `example/ios/SafeAreaViewExample.xcworkspace` in Xcode if you need to make changes to native code. | ||
|
||
#### Android | ||
|
||
```sh | ||
yarn android | ||
``` | ||
|
||
I also recommend opening `example/android` in Android Studio if you need to make changes to native code. | ||
|
||
Use `ctrl+cmd+z` on iOS or `ctrl+m` on Android to open the dev menu and choose an example. | ||
|
||
### Run tests | ||
|
||
```sh | ||
yarn test | ||
``` | ||
|
||
### Open a pull request! | ||
See https://docs.appandflow.com/react-native-safe-area-context/docs/contributing |
Oops, something went wrong.