Skip to content

Commit 8e413ed

Browse files
authored
chore: update README and adjust links to use main branch (#5476)
1 parent c5b4892 commit 8e413ed

58 files changed

Lines changed: 169 additions & 169 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/coverage.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Runs tests for all packages after pushes to master to check code coverage on a project level
1+
# Runs tests for all packages after pushes to main to check code coverage on a project level
22
name: Coverage
33

44
on:
55
push:
66
branches:
7-
- master
7+
- main
88

99
permissions:
1010
contents: read

‎DEVELOPMENT.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -181,13 +181,13 @@ yarn test:it
181181

182182
### Create a branch for the current major
183183

184-
Checkout master and pull latest changes:
184+
Checkout main and pull latest changes:
185185

186186
```sh
187-
git checkout master && git pull
187+
git checkout main && git pull
188188
```
189189

190-
Create a new branch from master:
190+
Create a new branch from main:
191191

192192
```sh
193193
git checkout -b 24.0
@@ -208,32 +208,32 @@ Create another branch:
208208
git checkout -b update-v24.0
209209
```
210210

211-
Update [`wtr-utils.js`](https://github.com/vaadin/web-components/blob/master/wtr-utils.js) as follows:
211+
Update [`wtr-utils.js`](https://github.com/vaadin/web-components/blob/main/wtr-utils.js) as follows:
212212

213213
```diff
214214
const isLockfileChanged = () => {
215-
- const log = execSync('git diff --name-only origin/master HEAD').toString();
215+
- const log = execSync('git diff --name-only origin/main HEAD').toString();
216216
+ const log = execSync('git diff --name-only origin/24.0 HEAD').toString();
217217
return log.split('\n').some((line) => line.includes('yarn.lock'));
218218
};
219219
```
220220

221221
```diff
222222
const getChangedPackages = () => {
223-
- const output = execSync('./node_modules/.bin/lerna ls --since origin/master --json --loglevel silent');
223+
- const output = execSync('./node_modules/.bin/lerna ls --since origin/main --json --loglevel silent');
224224
+ const output = execSync('./node_modules/.bin/lerna ls --since origin/24.0 --json --loglevel silent');
225225
return JSON.parse(output.toString());
226226
};
227227
```
228228

229229
Create a PR to the version branch ([example](https://github.com/vaadin/web-components/pull/4432)).
230230

231-
### Update the version in `master`
231+
### Update the version in `main`
232232

233-
Create a new branch from master:
233+
Create a new branch from main:
234234

235235
```sh
236-
git checkout master && git checkout -b bump-v24.1
236+
git checkout main && git checkout -b bump-v24.1
237237
```
238238

239239
Prepare a new version for the `updateVersion` script by running the following command:
@@ -257,10 +257,10 @@ lerna version 24.1.0-alpha0 --no-push --no-git-tag-version --force-publish --exa
257257
Commit all the changes:
258258

259259
```sh
260-
git commit -a -m "chore: update master branch to Vaadin 24.1"
260+
git commit -a -m "chore: update main branch to Vaadin 24.1"
261261
```
262262

263-
Create a PR to the `master` branch ([example](https://github.com/vaadin/web-components/pull/4433)).
263+
Create a PR to the `main` branch ([example](https://github.com/vaadin/web-components/pull/4433)).
264264

265265
### CI build updates
266266

@@ -362,7 +362,7 @@ After that you can start / restart your application and it should use the source
362362
When maintaining two stable majors (e.g. 22.0.x and 23.0.x), it is important to maintain `latest` npm tag.
363363
For example, we release 22.0.7 after 23.0.1 but we still want to keep `latest` pointing to 23.0.1.
364364

365-
Use the following script on `master` branch to run `npm dist-tag` for all packages:
365+
Use the following script on `main` branch to run `npm dist-tag` for all packages:
366366

367367
```sh
368368
./scripts/fixDistTag.sh

‎README.md‎

Lines changed: 57 additions & 57 deletions
Large diffs are not rendered by default.

‎packages/accordion/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A web component for displaying a vertically stacked set of expandable panels.
2020
</vaadin-accordion>
2121
```
2222

23-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/accordion/screenshot.png" alt="Screenshot of vaadin-accordion" width="900">](https://vaadin.com/docs/latest/components/accordion)
23+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/accordion/screenshot.png" alt="Screenshot of vaadin-accordion" width="900">](https://vaadin.com/docs/latest/components/accordion)
2424

2525
## Installation
2626

@@ -39,7 +39,7 @@ import '@vaadin/accordion';
3939
## Themes
4040

4141
Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/styling), Lumo and Material.
42-
The [main entrypoint](https://github.com/vaadin/web-components/blob/master/packages/accordion/vaadin-accordion.js) of the package uses the Lumo theme.
42+
The [main entrypoint](https://github.com/vaadin/web-components/blob/main/packages/accordion/vaadin-accordion.js) of the package uses the Lumo theme.
4343

4444
To use the Material theme, import the component from the `theme/material` folder:
4545

‎packages/app-layout/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ A web component for building common application layouts.
2929
</vaadin-app-layout>
3030
```
3131

32-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/app-layout/screenshot.png" width="900" alt="Screenshot of vaadin-app-layout">](https://vaadin.com/docs/latest/components/app-layout)
32+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/app-layout/screenshot.png" width="900" alt="Screenshot of vaadin-app-layout">](https://vaadin.com/docs/latest/components/app-layout)
3333

34-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/app-layout/screenshot-mobile.png" width="350" alt="Screenshot of vaadin-app-layout on mobile">](https://vaadin.com/docs/latest/components/app-layout)
34+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/app-layout/screenshot-mobile.png" width="350" alt="Screenshot of vaadin-app-layout on mobile">](https://vaadin.com/docs/latest/components/app-layout)
3535

3636
## Installation
3737

@@ -51,7 +51,7 @@ import '@vaadin/app-layout/vaadin-drawer-toggle.js';
5151
## Themes
5252

5353
Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/styling), Lumo and Material.
54-
The [main entrypoint](https://github.com/vaadin/web-components/blob/master/packages/app-layout/vaadin-app-layout.js) of the package uses the Lumo theme.
54+
The [main entrypoint](https://github.com/vaadin/web-components/blob/main/packages/app-layout/vaadin-app-layout.js) of the package uses the Lumo theme.
5555

5656
To use the Material theme, import the components from the `theme/material` folder:
5757

‎packages/avatar-group/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ A web component for grouping multiple [`<vaadin-avatar>`](https://www.npmjs.com/
1414
{ name: 'Foo Bar', colorIndex: 1 },
1515
{ colorIndex: 2 },
1616
{ name: 'Foo Bar', colorIndex: 3 },
17-
{ colorIndex: 4 }
17+
{ colorIndex: 4 },
1818
];
1919
</script>
2020
```
2121

22-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/avatar-group/screenshot.png" width="108" alt="Screenshot of vaadin-avatar-group">](https://vaadin.com/docs/latest/components/avatar/#avatar-group)
22+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/avatar-group/screenshot.png" width="108" alt="Screenshot of vaadin-avatar-group">](https://vaadin.com/docs/latest/components/avatar/#avatar-group)
2323

2424
## Installation
2525

@@ -38,7 +38,7 @@ import '@vaadin/avatar-group';
3838
## Themes
3939

4040
Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/styling), Lumo and Material.
41-
The [main entrypoint](https://github.com/vaadin/web-components/blob/master/packages/avatar-group/vaadin-avatar-group.js) of the package uses the Lumo theme.
41+
The [main entrypoint](https://github.com/vaadin/web-components/blob/main/packages/avatar-group/vaadin-avatar-group.js) of the package uses the Lumo theme.
4242

4343
To use the Material theme, import the component from the `theme/material` folder:
4444

‎packages/avatar/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A web component for graphical representation of an object or entity, for example
1313
<vaadin-avatar abbr="SK"></vaadin-avatar>
1414
```
1515

16-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/avatar/screenshot.png" width="132" alt="Screenshot of vaadin-avatar">](https://vaadin.com/docs/latest/components/avatar)
16+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/avatar/screenshot.png" width="132" alt="Screenshot of vaadin-avatar">](https://vaadin.com/docs/latest/components/avatar)
1717

1818
## Installation
1919

@@ -32,7 +32,7 @@ import '@vaadin/avatar';
3232
## Themes
3333

3434
Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/styling), Lumo and Material.
35-
The [main entrypoint](https://github.com/vaadin/web-components/blob/master/packages/avatar/vaadin-avatar.js) of the package uses the Lumo theme.
35+
The [main entrypoint](https://github.com/vaadin/web-components/blob/main/packages/avatar/vaadin-avatar.js) of the package uses the Lumo theme.
3636

3737
To use the Material theme, import the component from the `theme/material` folder:
3838

‎packages/board/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A powerful and easy to use layout web component for building responsive views.
3131
</vaadin-board>
3232
```
3333

34-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/board/screenshot.png" alt="Screenshot of vaadin-board">](https://vaadin.com/docs/latest/components/board)
34+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/board/screenshot.png" alt="Screenshot of vaadin-board">](https://vaadin.com/docs/latest/components/board)
3535

3636
## Installation
3737

‎packages/button/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ An accessible and customizable button that allows users to perform actions.
1313
<vaadin-button theme="tertiary">Tertiary</vaadin-button>
1414
```
1515

16-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/button/screenshot.png" width="296" alt="Screenshot of vaadin-button">](https://vaadin.com/docs/latest/components/button)
16+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/button/screenshot.png" width="296" alt="Screenshot of vaadin-button">](https://vaadin.com/docs/latest/components/button)
1717

1818
## Installation
1919

@@ -32,7 +32,7 @@ import '@vaadin/button';
3232
## Themes
3333

3434
Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/styling), Lumo and Material.
35-
The [main entrypoint](https://github.com/vaadin/web-components/blob/master/packages/button/vaadin-button.js) of the package uses the Lumo theme.
35+
The [main entrypoint](https://github.com/vaadin/web-components/blob/main/packages/button/vaadin-button.js) of the package uses the Lumo theme.
3636

3737
To use the Material theme, import the component from the `theme/material` folder:
3838

‎packages/charts/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ A feature-rich interactive charting library providing multiple different chart t
2424
</vaadin-chart>
2525
```
2626

27-
[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/charts/screenshot.png" width="530" alt="Screenshot of vaadin-chart">](https://vaadin.com/docs/latest/components/charts)
27+
[<img src="https://raw.githubusercontent.com/vaadin/web-components/main/packages/charts/screenshot.png" width="530" alt="Screenshot of vaadin-chart">](https://vaadin.com/docs/latest/components/charts)
2828

2929
## Installation
3030

0 commit comments

Comments
 (0)