Skip to content

Commit

Permalink
chore: rename master occurrences to main (software-mansion#2716)
Browse files Browse the repository at this point in the history
This PR renames all occurrences of master to main in order to achieve a smooth default branch rename. Only changes in .github/workflows are necessary but I've also changed the documentation to make all the links consistent with the new naming.
  • Loading branch information
kacperkapusciak authored Dec 9, 2021
1 parent f9ab105 commit 688a244
Show file tree
Hide file tree
Showing 33 changed files with 60 additions and 60 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/android-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ name: Test Android build
on:
pull_request:
branches:
- master
- main
paths:
- 'android/**'
- 'Common/**'
push:
branches:
- master
- main
jobs:
build:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -36,4 +36,4 @@ jobs:
run: yarn
- name: Build app
working-directory: ${{ env.WORKING_DIRECTORY }}/android
run: ./gradlew assembleDebug --console=plain
run: ./gradlew assembleDebug --console=plain
6 changes: 3 additions & 3 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: Test docs build

on:
pull_request:
branches:
- master
branches:
- main
paths:
- 'docs/**'

Expand All @@ -23,6 +23,6 @@ jobs:
- name: Install node dependencies
working-directory: ${{ env.WORKING_DIRECTORY }}
run: yarn
- name: Build docs
- name: Build docs
working-directory: ${{ env.WORKING_DIRECTORY }}
run: yarn build
6 changes: 3 additions & 3 deletions .github/workflows/ios-build.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Test iOS build
on:
pull_request:
branches:
- master
branches:
- main
paths:
- 'ios/**'
- 'Common/**'
push:
branches:
- master
- main
jobs:
build:
# runs-on: macos-latest // issue: https://github.com/actions/virtual-environments/issues/4060
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Publish to GitHub Pages
on:
push:
branches:
- master
- main

jobs:
publish:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/static-example-app-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ name: Test Example App TypeScript and Lint
on:
pull_request:
branches:
- master
- main
paths:
- 'Example/**'
push:
branches:
- master
- main
jobs:
check:
runs-on: ubuntu-latest
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/static-root-checks.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
name: Test TypeScript and Lint
on:
pull_request:
branches:
- master
branches:
- main
paths:
- 'src/**'
- '*'
push:
branches:
- master
- main
jobs:
check:
runs-on: ubuntu-latest
concurrency:
concurrency:
group: static-root-${{ github.ref }}
cancel-in-progress: true
steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate-cpp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Validate C++
on:
push:
branches:
- master
- main
paths:
- '.github/workflows/validate-cpp.yml'
- 'Common/cpp/**'
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/validate-java.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
name: Java Lint
on:
pull_request:
branches:
- master
branches:
- main
paths:
- 'android/src/java**'
push:
branches:
- master
- main
jobs:
check:
runs-on: ubuntu-latest
concurrency:
concurrency:
group: static-root-${{ github.ref }}
cancel-in-progress: true
steps:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Check out our dedicated documentation page for info about this library, API refe

## Examples

The source code for the example (showcase) app is under the [`Example/`](https://github.com/software-mansion/react-native-reanimated/blob/master/Example/) directory.
The source code for the example (showcase) app is under the [`Example/`](https://github.com/software-mansion/react-native-reanimated/blob/main/Example/) directory.
If you want to play with the API but don't feel like trying it on a real app, you can run the example project. Check Example/ directory README for installation instructions.

## License
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/fundamentals/animations.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ offset.value = withTiming(0, {
```

You may want to visit [easings.net](https://easings.net/) and check various easing visualizations.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/master/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/main/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.

### Spring

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/fundamentals/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ yarn add react-native-reanimated@next

To use experimental support of Reanimated 2 in the Expo managed apps follow [their installation instructions](https://docs.expo.io/versions/latest/sdk/reanimated/).

### Using master branch builds
### Using main branch builds

To use Reanimated 2 built from the master branch:
To use Reanimated 2 built from the main branch:

- go to the ["Build npm package" workflow in Reanimated repository](https://github.com/software-mansion/react-native-reanimated/actions?query=workflow%3A%22Build+npm+package%22)
- select latest build and download `react-native-reanimated-2.0.0-alpha.tgz` artifact
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ test('stop in a middle of animation', () => {
```

More example tests you can see in our repository
- [SharedValue.test.js](https://github.com/software-mansion/react-native-reanimated/tree/master/__tests__/SharedValue.test.js)
- [Animation.test.js](https://github.com/software-mansion/react-native-reanimated/tree/master/__tests__/Animation.test.js)
- [SharedValue.test.js](https://github.com/software-mansion/react-native-reanimated/tree/main/__tests__/SharedValue.test.js)
- [Animation.test.js](https://github.com/software-mansion/react-native-reanimated/tree/main/__tests__/Animation.test.js)

## Recommended testing library

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const bannerDescription =
const blogUrl =
'https://blog.swmansion.com/introducing-reanimated-2-752b913af8b3';
const exampleUrl =
'https://github.com/software-mansion/react-native-reanimated/tree/master/Example';
'https://github.com/software-mansion/react-native-reanimated/tree/main/Example';
const playgroundUrl =
'https://github.com/software-mansion-labs/reanimated-2-playground';
const tryItOutDecription =
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-1.x.x/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ The current algorithm for making decisions of which nodes to evaluate works as f

`react-native-reanimated` works best with the [Gesture Handler](https://kmagiera.github.io/react-native-gesture-handler)
library. Currently all the examples are made using that library, including the ultimate
[ImagePreview app](https://github.com/software-mansion/react-native-reanimated/blob/master/Example/src/imageViewer).
[ImagePreview app](https://github.com/software-mansion/react-native-reanimated/blob/main/Example/src/imageViewer).
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Transforms an object with `bounciness` and `speed` params into config expected b

Transforms an object with `tension` and `friction` params into config expected by the `spring` node. `tension` and `friction` might be nodes or numbers.

See an [Example of different configs](https://github.com/software-mansion/react-native-reanimated/blob/master/Example/reanimated1/differentSpringConfigs/index.js).
See an [Example of different configs](https://github.com/software-mansion/react-native-reanimated/blob/main/Example/reanimated1/differentSpringConfigs/index.js).
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-1.x.x/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_label: Additional configuration

Reanimated exports two functions that control which properties can be animated natively:

1. `addWhitelistedNativeProps()` is used to animate properties that triggers layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L31).
1. `addWhitelistedNativeProps()` is used to animate properties that triggers layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L31).

2. `addWhitelistedUIProps()` is used for any other properties, current allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L6).
2. `addWhitelistedUIProps()` is used for any other properties, current allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L6).

You can use them to animate properties that Reanimated don't support by default.
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-1.x.x/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Event handling

`react-native-reanimated`'s new syntax is possible to be used with `Animated.event`. Instead of providing only a mapping from event fields to animated nodes, it is allowed to write a function that takes reanimated values map as an input and return a block (or any other reanimated function) that will be then used to handle the event.

This syntax allows for providing some post-processing for the event data that does not fit well as a dependency of other nodes we connect to `Animated.View` component props. [See example](https://github.com/software-mansion/react-native-reanimated/blob/master/Example/reanimated1/PanRotateAndZoom/index.js#L25)
This syntax allows for providing some post-processing for the event data that does not fit well as a dependency of other nodes we connect to `Animated.View` component props. [See example](https://github.com/software-mansion/react-native-reanimated/blob/main/Example/reanimated1/PanRotateAndZoom/index.js#L25)

```js
import { event, set } from 'react-native-reanimated'
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-1.x.x/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Examples
sidebar_label: Examples
---

The source code for the example (showcase) app is under the [`Example/`](https://github.com/software-mansion/react-native-reanimated/blob/master/Example/) directory.
The source code for the example (showcase) app is under the [`Example/`](https://github.com/software-mansion/react-native-reanimated/blob/main/Example/) directory.

In order to run it you need to run those commands (starting at main directory):

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-1.x.x/transitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ Use `Transition.Change` component to specify how components' which properties ge

## How to use it

This API is still experimental and is a subject to change. Please refer to our [Example app](https://github.com/software-mansion/react-native-reanimated/tree/master/Example/reanimated1/transitions) to see how it can be used in practice in the current shape.
This API is still experimental and is a subject to change. Please refer to our [Example app](https://github.com/software-mansion/react-native-reanimated/tree/main/Example/reanimated1/transitions) to see how it can be used in practice in the current shape.
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-2.0.0/animations.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ offset.value = withTiming(0, {
```

You may want to visit [easings.net](https://easings.net/) and check various easing visualizations.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/master/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/main/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.

### Spring

Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.0.0/api/useAnimatedProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Only "native" properties of "native views" can be set via `useAnimatedProps`.
The most common usecase for this hook is when we want to animate properties of some third-party native component, since most of the properties for the core React Native components are a part of the styles anyways (at least the properties for which it makes sense to be animated).
You can use the following functions to animate properties that Reanimated don't support by default:

1. `addWhitelistedNativeProps()` is used to animate properties that trigger layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L31).
1. `addWhitelistedNativeProps()` is used to animate properties that trigger layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L31).

2. `addWhitelistedUIProps()` is used for properties that are updated directly on the UI thread, currently allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L6).
2. `addWhitelistedUIProps()` is used for properties that are updated directly on the UI thread, currently allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L6).

In order to connect the `useAnimatedProps` hook result to a view, you need to pass it as `animatedProps` property to the `Animated` version of the component (e.g., `Animated.View`).
The `animatedProps` property is added when a native component is wrapped with `Animated.createAnimatedComponent`.
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.0.0/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ yarn add react-native-reanimated@next

To use experimental support of Reanimated 2 in the Expo managed apps follow [their installation instructions](https://docs.expo.io/versions/latest/sdk/reanimated/).

### Using master branch builds
### Using main branch builds

To use Reanimated 2 built from the master branch:
To use Reanimated 2 built from the main branch:

- go to the ["Build npm package" workflow in Reanimated repository](https://github.com/software-mansion/react-native-reanimated/actions?query=workflow%3A%22Build+npm+package%22)
- select latest build and download `react-native-reanimated-2.0.0-alpha.tgz` artifact
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.0.0/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ test('stop in a middle of animation', () => {
```

More example tests you can see in our repository
- [SharedValue.test.js](https://github.com/software-mansion/react-native-reanimated/tree/master/__tests__/SharedValue.test.js)
- [Animation.test.js](https://github.com/software-mansion/react-native-reanimated/tree/master/__tests__/Animation.test.js)
- [SharedValue.test.js](https://github.com/software-mansion/react-native-reanimated/tree/main/__tests__/SharedValue.test.js)
- [Animation.test.js](https://github.com/software-mansion/react-native-reanimated/tree/main/__tests__/Animation.test.js)

## Recommended testing library

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-2.1.0/animations.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ offset.value = withTiming(0, {
```

You may want to visit [easings.net](https://easings.net/) and check various easing visualizations.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/master/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/main/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.

### Spring

Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.1.0/api/useAnimatedProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Only "native" properties of "native views" can be set via `useAnimatedProps`.
The most common usecase for this hook is when we want to animate properties of some third-party native component, since most of the properties for the core React Native components are a part of the styles anyways (at least the properties for which it makes sense to be animated).
You can use the following functions to animate properties that Reanimated don't support by default:

1. `addWhitelistedNativeProps()` is used to animate properties that trigger layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L31).
1. `addWhitelistedNativeProps()` is used to animate properties that trigger layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L31).

2. `addWhitelistedUIProps()` is used for properties that are updated directly on the UI thread, currently allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L6).
2. `addWhitelistedUIProps()` is used for properties that are updated directly on the UI thread, currently allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L6).

In order to connect the `useAnimatedProps` hook result to a view, you need to pass it as `animatedProps` property to the `Animated` version of the component (e.g., `Animated.View`).
The `animatedProps` property is added when a native component is wrapped with `Animated.createAnimatedComponent`.
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.1.0/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ yarn add react-native-reanimated@next

To use experimental support of Reanimated 2 in the Expo managed apps follow [their installation instructions](https://docs.expo.io/versions/latest/sdk/reanimated/).

### Using master branch builds
### Using main branch builds

To use Reanimated 2 built from the master branch:
To use Reanimated 2 built from the main branch:

- go to the ["Build npm package" workflow in Reanimated repository](https://github.com/software-mansion/react-native-reanimated/actions?query=workflow%3A%22Build+npm+package%22)
- select latest build and download `react-native-reanimated-2.0.0-alpha.tgz` artifact
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.1.0/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ test('stop in a middle of animation', () => {
```

More example tests you can see in our repository
- [SharedValue.test.js](https://github.com/software-mansion/react-native-reanimated/tree/master/__tests__/SharedValue.test.js)
- [Animation.test.js](https://github.com/software-mansion/react-native-reanimated/tree/master/__tests__/Animation.test.js)
- [SharedValue.test.js](https://github.com/software-mansion/react-native-reanimated/tree/main/__tests__/SharedValue.test.js)
- [Animation.test.js](https://github.com/software-mansion/react-native-reanimated/tree/main/__tests__/Animation.test.js)

## Recommended testing library

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-2.2.0/animations.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ offset.value = withTiming(0, {
```

You may want to visit [easings.net](https://easings.net/) and check various easing visualizations.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/master/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.
To learn how to apply these please refer to [Easing.ts](https://github.com/software-mansion/react-native-reanimated/blob/main/src/reanimated2/Easing.ts) file where all the easing related helper methods are defined.

### Spring

Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.2.0/api/useAnimatedProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Only "native" properties of "native views" can be set via `useAnimatedProps`.
The most common usecase for this hook is when we want to animate properties of some third-party native component, since most of the properties for the core React Native components are a part of the styles anyways (at least the properties for which it makes sense to be animated).
You can use the following functions to animate properties that Reanimated don't support by default:

1. `addWhitelistedNativeProps()` is used to animate properties that trigger layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L31).
1. `addWhitelistedNativeProps()` is used to animate properties that trigger layout recalculation, you can find them [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L31).

2. `addWhitelistedUIProps()` is used for properties that are updated directly on the UI thread, currently allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/master/src/ConfigHelper.js#L6).
2. `addWhitelistedUIProps()` is used for properties that are updated directly on the UI thread, currently allowed props are listed [here](https://github.com/software-mansion/react-native-reanimated/blob/main/src/ConfigHelper.js#L6).

In order to connect the `useAnimatedProps` hook result to a view, you need to pass it as `animatedProps` property to the `Animated` version of the component (e.g., `Animated.View`).
The `animatedProps` property is added when a native component is wrapped with `Animated.createAnimatedComponent`.
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-2.2.0/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ yarn add react-native-reanimated@next

To use experimental support of Reanimated 2 in the Expo managed apps follow [their installation instructions](https://docs.expo.io/versions/latest/sdk/reanimated/).

### Using master branch builds
### Using main branch builds

To use Reanimated 2 built from the master branch:
To use Reanimated 2 built from the main branch:

- go to the ["Build npm package" workflow in Reanimated repository](https://github.com/software-mansion/react-native-reanimated/actions?query=workflow%3A%22Build+npm+package%22)
- select latest build and download `react-native-reanimated-2.0.0-alpha.tgz` artifact
Expand Down
Loading

0 comments on commit 688a244

Please sign in to comment.