Skip to content

Commit

Permalink
chore: migrated to PNPM
Browse files Browse the repository at this point in the history
  • Loading branch information
semoal committed Oct 5, 2021
1 parent 1b79ebb commit 5b1b99a
Show file tree
Hide file tree
Showing 29 changed files with 20,768 additions and 107,618 deletions.
27 changes: 22 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,30 @@ jobs:
with:
persist-credentials: false

- run: |
npm i
npm run bootstrap -- --ci --concurrency=2
npm run build
- name: Install pnpm
run: npm i pnpm@6.10.3 -g

- name: Set pnpm global store
run: |
mkdir ~/.pnpm-store
pnpm config set store-dir ~/.pnpm-store
- name: Install
run: pnpm recursive install --frozen-lockfile

- name: Cache .pnpm-store
uses: actions/cache@v2
with:
path: ~/.pnpm-store
key: pnpm-${{ hashFiles('pnpm-lock.yaml') }}
restore-keys: |
pnpm-
- run: pnpm run build

- name: Install and Build 🔧
run: |
cd packages/docs && npm run build-docs
cd packages/docs && pnpm run build-docs
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@3.7.1
Expand Down
31 changes: 20 additions & 11 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,26 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
version: ${{ matrix.versionffmpeg_version }}

- name: Install, Build & Test for Node 16 and NPM 7
if: matrix.node_version >= 16
- name: Install pnpm
run: npm i pnpm@6.10.3 -g

- name: Set pnpm global store
run: |
npm i
npm run build
npm test
mkdir ~/.pnpm-store
pnpm config set store-dir ~/.pnpm-store
- name: Install
run: pnpm recursive install --frozen-lockfile

- name: Cache .pnpm-store
uses: actions/cache@v2
with:
path: ~/.pnpm-store
key: pnpm-${{ hashFiles('pnpm-lock.yaml') }}
restore-keys: |
pnpm-
- name: Install, Build & Test for Node 12,14 and NPM 6
if: matrix.node_version <= 16
- name: Build & Test
run: |
npm i
npm run bootstrap -- --ci --concurrency=2
npm run build
npm test
pnpm run build
pnpm test
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
node_modules
dist
tsconfig.tsbuildinfo
lerna-debug.log
.DS_Store
coverage
packages/example/.env
Expand Down
44 changes: 23 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,43 +16,45 @@ Please note that this project is released with a [Contributor Code of Conduct](C

### Code setup

Clone the repo and run
Remotion uses [`pnpm`](https://pnpm.io/) as the package manager for development in this repository.

Since we use NPM and Lerna, we suggest to check which version of Node and NPM you're using, we're compatible with both but steps changes.
If you are using pnpm for the first time the [pnpm configuration documentation](https://pnpm.io/configuring) may be useful to avoid any potential problems with the following steps.

#### Node 16
To begin your development setup, please install the latest version of pnpm globally:

```console
npm i

npm run build

npm run test
```
npm i -g pnpm
```

#### Node 12, 14
With pnpm installed, the first step is installing all dependencies:

```console
npm i
```
pnpm install
```

npm run bootstrap
### Building the project

npm run build
To build the project run

npm run test
```
pnpm build
```

We recommend keeping a terminal open with the command

```console
### Watch mode

npm run watch
To enable watch mode run

```
pnpm watch
```

### Running test

running to keep the monorepos building and synchronized.
```
pnpm test
```

As a testbed, you can use the `example` folder. Run `npm start` to trigger the preview and `npm run render` to trigger the render process.
As a testbed, you can use the `example` folder. Run `pnpm start` to trigger the preview and `pnpm render` to trigger the render process.

### Testing

Expand Down
6 changes: 3 additions & 3 deletions TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ For general information concerning contribution, please consult [CONTRIBUTION.md

### Core Coverage

![statements](https://img.shields.io/badge/Coverage_statements-77.21%25-yellow.svg)
![branches](https://img.shields.io/badge/Coverage_branches-71.23%25-yellow.svg)
![statements](https://img.shields.io/badge/Coverage_statements-77.16%25-yellow.svg)
![branches](https://img.shields.io/badge/Coverage_branches-71.16%25-yellow.svg)
![functions](https://img.shields.io/badge/Coverage_functions-60.96%25-red.svg)
![lines](https://img.shields.io/badge/Coverage_lines-76.1%25-yellow.svg)
![lines](https://img.shields.io/badge/Coverage_lines-76.05%25-yellow.svg)

### Running tests

Expand Down
6 changes: 0 additions & 6 deletions lerna.json

This file was deleted.

Loading

0 comments on commit 5b1b99a

Please sign in to comment.