Skip to content

Commit 42dd355

Browse files
charpenicharpeni
authored
docs: sort continuous integration recipes alphabetically (#675)
1 parent fb419d0 commit 42dd355

File tree

1 file changed

+132
-133
lines changed

1 file changed

+132
-133
lines changed

‎docs/continuous-integration.md

Lines changed: 132 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -11,56 +11,6 @@ In all the provided configuration files the store is cached. However, this is no
1111

1212
:::
1313

14-
## Travis
15-
16-
On [Travis CI], you can use pnpm for installing your dependencies by adding this
17-
to your `.travis.yml` file:
18-
19-
```yaml title=".travis.yml"
20-
cache:
21-
npm: false
22-
directories:
23-
- "~/.pnpm-store"
24-
before_install:
25-
- npm install --global corepack@latest
26-
- corepack enable
27-
- corepack prepare pnpm@latest-10 --activate
28-
- pnpm config set store-dir ~/.pnpm-store
29-
install:
30-
- pnpm install
31-
```
32-
33-
[Travis CI]: https://travis-ci.org
34-
35-
## Semaphore
36-
37-
On [Semaphore], you can use pnpm for installing and caching your dependencies by
38-
adding this to your `.semaphore/semaphore.yml` file:
39-
40-
```yaml title=".semaphore/semaphore.yml"
41-
version: v1.0
42-
name: Semaphore CI pnpm example
43-
agent:
44-
machine:
45-
type: e1-standard-2
46-
os_image: ubuntu1804
47-
blocks:
48-
- name: Install dependencies
49-
task:
50-
jobs:
51-
- name: pnpm install
52-
commands:
53-
- npm install --global corepack@latest
54-
- corepack enable
55-
- corepack prepare pnpm@latest-10 --activate
56-
- checkout
57-
- cache restore node-$(checksum pnpm-lock.yaml)
58-
- pnpm install
59-
- cache store node-$(checksum pnpm-lock.yaml) $(pnpm store path)
60-
```
61-
62-
[Semaphore]: https://semaphoreci.com
63-
6414
## AppVeyor
6515

6616
On [AppVeyor], you can use pnpm for installing your dependencies by adding this
@@ -77,62 +27,32 @@ install:
7727
7828
[AppVeyor]: https://www.appveyor.com
7929
80-
## GitHub Actions
81-
82-
On GitHub Actions, you can use pnpm for installing and caching your dependencies
83-
like so (belongs in `.github/workflows/NAME.yml`):
84-
85-
```yaml title=".github/workflows/NAME.yml"
86-
name: pnpm Example Workflow
87-
on:
88-
push:
30+
## Azure Pipelines
8931
90-
jobs:
91-
build:
92-
runs-on: ubuntu-22.04
93-
strategy:
94-
matrix:
95-
node-version: [20]
96-
steps:
97-
- uses: actions/checkout@v4
98-
- name: Install pnpm
99-
uses: pnpm/action-setup@v4
100-
with:
101-
version: 10
102-
- name: Use Node.js ${{ matrix.node-version }}
103-
uses: actions/setup-node@v4
104-
with:
105-
node-version: ${{ matrix.node-version }}
106-
cache: 'pnpm'
107-
- name: Install dependencies
108-
run: pnpm install
109-
```
32+
On Azure Pipelines, you can use pnpm for installing and caching your dependencies by adding this to your `azure-pipelines.yml`:
11033

111-
## GitLab CI
34+
```yaml title="azure-pipelines.yml"
35+
variables:
36+
pnpm_config_cache: $(Pipeline.Workspace)/.pnpm-store
11237
113-
On GitLab, you can use pnpm for installing and caching your dependencies
114-
like so (belongs in `.gitlab-ci.yml`):
38+
steps:
39+
- task: Cache@2
40+
inputs:
41+
key: 'pnpm | "$(Agent.OS)" | pnpm-lock.yaml'
42+
path: $(pnpm_config_cache)
43+
displayName: Cache pnpm
11544
116-
```yaml title=".gitlab-ci.yml"
117-
stages:
118-
- build
45+
- script: |
46+
npm install --global corepack@latest
47+
corepack enable
48+
corepack prepare pnpm@latest-10 --activate
49+
pnpm config set store-dir $(pnpm_config_cache)
50+
displayName: "Setup pnpm"
11951
120-
build:
121-
stage: build
122-
image: node:18.17.1
123-
before_script:
124-
- npm install --global corepack@latest
125-
- corepack enable
126-
- corepack prepare pnpm@latest-10 --activate
127-
- pnpm config set store-dir .pnpm-store
128-
script:
129-
- pnpm install # install dependencies
130-
cache:
131-
key:
132-
files:
133-
- pnpm-lock.yaml
134-
paths:
135-
- .pnpm-store
52+
- script: |
53+
pnpm install
54+
pnpm run build
55+
displayName: "pnpm install and build"
13656
```
13757

13858
## Bitbucket Pipelines
@@ -160,35 +80,6 @@ pipelines:
16080
- pnpm
16181
```
16282

163-
## Azure Pipelines
164-
165-
On Azure Pipelines, you can use pnpm for installing and caching your dependencies by adding this to your `azure-pipelines.yml`:
166-
167-
```yaml title="azure-pipelines.yml"
168-
variables:
169-
pnpm_config_cache: $(Pipeline.Workspace)/.pnpm-store
170-
171-
steps:
172-
- task: Cache@2
173-
inputs:
174-
key: 'pnpm | "$(Agent.OS)" | pnpm-lock.yaml'
175-
path: $(pnpm_config_cache)
176-
displayName: Cache pnpm
177-
178-
- script: |
179-
npm install --global corepack@latest
180-
corepack enable
181-
corepack prepare pnpm@latest-10 --activate
182-
pnpm config set store-dir $(pnpm_config_cache)
183-
displayName: "Setup pnpm"
184-
185-
- script: |
186-
pnpm install
187-
pnpm run build
188-
displayName: "pnpm install and build"
189-
```
190-
191-
19283
## CircleCI
19384

19485
On CircleCI, you can use pnpm for installing and caching your dependencies by adding this to your `.circleci/config.yml`:
@@ -227,6 +118,64 @@ jobs:
227118
- .pnpm-store
228119
```
229120

121+
## GitHub Actions
122+
123+
On GitHub Actions, you can use pnpm for installing and caching your dependencies
124+
like so (belongs in `.github/workflows/NAME.yml`):
125+
126+
```yaml title=".github/workflows/NAME.yml"
127+
name: pnpm Example Workflow
128+
on:
129+
push:
130+
131+
jobs:
132+
build:
133+
runs-on: ubuntu-22.04
134+
strategy:
135+
matrix:
136+
node-version: [20]
137+
steps:
138+
- uses: actions/checkout@v4
139+
- name: Install pnpm
140+
uses: pnpm/action-setup@v4
141+
with:
142+
version: 10
143+
- name: Use Node.js ${{ matrix.node-version }}
144+
uses: actions/setup-node@v4
145+
with:
146+
node-version: ${{ matrix.node-version }}
147+
cache: "pnpm"
148+
- name: Install dependencies
149+
run: pnpm install
150+
```
151+
152+
## GitLab CI
153+
154+
On GitLab, you can use pnpm for installing and caching your dependencies
155+
like so (belongs in `.gitlab-ci.yml`):
156+
157+
```yaml title=".gitlab-ci.yml"
158+
stages:
159+
- build
160+
161+
build:
162+
stage: build
163+
image: node:18.17.1
164+
before_script:
165+
- npm install --global corepack@latest
166+
- corepack enable
167+
- corepack prepare pnpm@latest-10 --activate
168+
- pnpm config set store-dir .pnpm-store
169+
script:
170+
- pnpm install # install dependencies
171+
cache:
172+
key:
173+
files:
174+
- pnpm-lock.yaml
175+
paths:
176+
- .pnpm-store
177+
```
178+
230179
## Jenkins
231180

232181
You can use pnpm for installing and caching your dependencies:
@@ -235,12 +184,12 @@ You can use pnpm for installing and caching your dependencies:
235184
pipeline {
236185
agent {
237186
docker {
238-
image 'node:lts-bullseye-slim'
239-
args '-p 3000:3000'
187+
image 'node:lts-bullseye-slim'
188+
args '-p 3000:3000'
240189
}
241190
}
242191
stages {
243-
stage('Build') {
192+
stage('Build') {
244193
steps {
245194
sh 'npm install --global corepack@latest'
246195
sh 'corepack enable'
@@ -251,3 +200,53 @@ pipeline {
251200
}
252201
}
253202
```
203+
204+
## Semaphore
205+
206+
On [Semaphore], you can use pnpm for installing and caching your dependencies by
207+
adding this to your `.semaphore/semaphore.yml` file:
208+
209+
```yaml title=".semaphore/semaphore.yml"
210+
version: v1.0
211+
name: Semaphore CI pnpm example
212+
agent:
213+
machine:
214+
type: e1-standard-2
215+
os_image: ubuntu1804
216+
blocks:
217+
- name: Install dependencies
218+
task:
219+
jobs:
220+
- name: pnpm install
221+
commands:
222+
- npm install --global corepack@latest
223+
- corepack enable
224+
- corepack prepare pnpm@latest-10 --activate
225+
- checkout
226+
- cache restore node-$(checksum pnpm-lock.yaml)
227+
- pnpm install
228+
- cache store node-$(checksum pnpm-lock.yaml) $(pnpm store path)
229+
```
230+
231+
[Semaphore]: https://semaphoreci.com
232+
233+
## Travis
234+
235+
On [Travis CI], you can use pnpm for installing your dependencies by adding this
236+
to your `.travis.yml` file:
237+
238+
```yaml title=".travis.yml"
239+
cache:
240+
npm: false
241+
directories:
242+
- "~/.pnpm-store"
243+
before_install:
244+
- npm install --global corepack@latest
245+
- corepack enable
246+
- corepack prepare pnpm@latest-10 --activate
247+
- pnpm config set store-dir ~/.pnpm-store
248+
install:
249+
- pnpm install
250+
```
251+
252+
[Travis CI]: https://travis-ci.org

0 commit comments

Comments
 (0)