https://github.com/tf63/node-ci-exp

https://github.com/tf63/node-ci-exp

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tf63/node-ci-exp
• Owner: tf63
• Created: 2024-07-07T08:58:21.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-07T23:38:38.000Z (4 months ago)
• Last Synced: 2024-07-08T11:02:31.988Z (4 months ago)
• Language: TypeScript
• Size: 708 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NodeのCIを試すだけ

### キャッシュ無し

-   ベースライン

### `actions/setup-node@v3`を使う

https://github.com/actions/setup-node/tree/main

-   `.npm`をキャッシュする

```

    - uses: actions/checkout@v3

    - uses: actions/setup-node@v3

        with:

            node-version: '20'

            cache: 'npm'

    - run: npm ci

```

### node_modulesをキャッシュする

-   `setup-node`はデフォルトでキャッシュを作成しない

-   `with > cache`を指定しないようにすれば環境を作れる

```

    - uses: actions/checkout@v3

    - uses: actions/setup-node@v3

        with:

            node-version: '20'

    - uses: actions/cache@v3

        id: node_modules_cache

        with:

            path: '**/node_modules'

            key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}

            restore-keys: |

                ${{ runner.os }}-node-modules-

    - run: npm ci

```

### pnpmを使う

`pnpm/action-setup`を使わずとも`corepack enable`するだけでよい

https://zenn.dev/longrun_jp/articles/hello-corepack-goodbye-pnpm-action-setup

```

    - uses: actions/checkout@v4

    - run: corepack enable

    - uses: actions/setup-node@v4

        with:

            node-version: '20'

            cache: 'pnpm'

    - run: pnpm install --frozen-lockfile

```

-   `npm ci`の代わりに`pnpm install --frozen-lockfile`を使う (`--frozen-lockfile`はなくてもよいかも)

https://stackoverflow.com/questions/70154568/pnpm-equivalent-command-for-npm-ci

https://pnpm.io/npmrc#prefer-frozen-lockfile

## キャッシュの再検証

キャッシュのキーに`package-lock.json`のハッシュ値を使用している

![alt text](img/README.png)

## 備考

**npm installは`package-lock.json`を更新する**

-   `npm ci`を使った方が良い

-   `setup-node`のサンプルでも`npm ci`を使っている

    https://qiita.com/mstssk/items/8759c71f328cab802670

**npm ciはnode_modulesを一度削除する**

-   `npm ci`の実行時に`node_modules`が存在する場合，一度削除してから`node_modules`を入れ直すらしい

-   `node_modules`をキャッシュしても削除されてしまいそう