Skip to content

Commit cb48363

Browse files
authored
docs: fix status badges in readme (#1143)
1 parent 4090c65 commit cb48363

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Examples contained in this repository, based on current Cypress versions, can be
6767

6868
Live examples, such as [example-basic.yml](.github/workflows/example-basic.yml) are shown together with a status badge. Click on the status badge to read the source code of the workflow, for example
6969

70-
[![End-to-End example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
70+
[![End-to-End example](https://github.com/cypress-io/github-action/actions/workflows/example-basic.yml/badge.svg)](.github/workflows/example-basic.yml)
7171

7272
Older **external** examples based on a [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration) for Cypress `9` and earlier can be found in the [README](https://github.com/cypress-io/github-action/blob/v5/README.md) for version `v5`.
7373

@@ -90,7 +90,7 @@ jobs:
9090
uses: cypress-io/github-action@v6
9191
```
9292
93-
[![End-to-End example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
93+
[![End-to-End example](https://github.com/cypress-io/github-action/actions/workflows/example-basic.yml/badge.svg)](.github/workflows/example-basic.yml)
9494
9595
The workflow file [example-basic.yml](.github/workflows/example-basic.yml) shows how Cypress runs on GH Actions using Ubuntu (20 and 22), Windows, and macOS without additional OS dependencies necessary.
9696
@@ -115,7 +115,7 @@ jobs:
115115
component: true
116116
```
117117

118-
[![Component Testing example](https://github.com/cypress-io/github-action/workflows/example-component-test/badge.svg?branch=master)](.github/workflows/example-component-test.yml)
118+
[![Component Testing example](https://github.com/cypress-io/github-action/actions/workflows/example-component-test.yml/badge.svg)](.github/workflows/example-component-test.yml)
119119

120120
See the example project [component-tests](examples/component-tests/) and the [example-component-test.yml](.github/workflows/example-component-test.yml) workflow for more details.
121121

@@ -161,7 +161,7 @@ jobs:
161161
browser: chrome
162162
```
163163

164-
[![Chrome example](https://github.com/cypress-io/github-action/workflows/example-chrome/badge.svg?branch=master)](.github/workflows/example-chrome.yml)
164+
[![Chrome example](https://github.com/cypress-io/github-action/actions/workflows/example-chrome.yml/badge.svg)](.github/workflows/example-chrome.yml)
165165

166166
### Firefox
167167

@@ -179,7 +179,7 @@ jobs:
179179
browser: firefox
180180
```
181181

182-
[![Firefox example](https://github.com/cypress-io/github-action/workflows/example-firefox/badge.svg?branch=master)](.github/workflows/example-firefox.yml)
182+
[![Firefox example](https://github.com/cypress-io/github-action/actions/workflows/example-firefox.yml/badge.svg)](.github/workflows/example-firefox.yml)
183183

184184
### Edge
185185

@@ -197,7 +197,7 @@ jobs:
197197
browser: edge
198198
```
199199

200-
[![Edge example](https://github.com/cypress-io/github-action/workflows/example-edge/badge.svg?branch=master)](.github/workflows/example-edge.yml)
200+
[![Edge example](https://github.com/cypress-io/github-action/actions/workflows/example-edge.yml/badge.svg)](.github/workflows/example-edge.yml)
201201

202202
### Headed
203203

@@ -245,7 +245,7 @@ Include `options: --user 1001` to avoid permissions issues.
245245

246246
Refer to [cypress-io/cypress-docker-images](https://github.com/cypress-io/cypress-docker-images) for further information about using Cypress Docker images. Cypress offers the [Cypress Docker Factory](https://github.com/cypress-io/cypress-docker-images/tree/master/factory) to generate additional Docker images with selected components and versions.
247247

248-
[![Docker example](https://github.com/cypress-io/github-action/workflows/example-docker/badge.svg?branch=master)](.github/workflows/example-docker.yml)
248+
[![Docker example](https://github.com/cypress-io/github-action/actions/workflows/example-docker.yml/badge.svg)](.github/workflows/example-docker.yml)
249249

250250
### Env
251251

@@ -288,7 +288,7 @@ jobs:
288288

289289
For more examples, see the workflows below, using environment variables for [recording](#record-test-results-on-cypress-cloud).
290290

291-
[![Env example](https://github.com/cypress-io/github-action/workflows/example-env/badge.svg?branch=master)](.github/workflows/example-env.yml)
291+
[![Env example](https://github.com/cypress-io/github-action/actions/workflows/example-env.yml/badge.svg)](.github/workflows/example-env.yml)
292292

293293
### Specs
294294

@@ -369,7 +369,7 @@ jobs:
369369
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
370370
```
371371

372-
[![recording example](https://github.com/cypress-io/github-action/workflows/example-recording/badge.svg?branch=master)](.github/workflows/example-recording.yml)
372+
[![recording example](https://github.com/cypress-io/github-action/actions/workflows/example-recording.yml/badge.svg)](.github/workflows/example-recording.yml)
373373

374374
### Project ID and Record Key
375375

@@ -619,7 +619,7 @@ jobs:
619619
quiet: true
620620
```
621621
622-
[![example-quiet](https://github.com/cypress-io/github-action/workflows/example-quiet/badge.svg?branch=master)](.github/workflows/example-quiet.yml)
622+
[![example-quiet](https://github.com/cypress-io/github-action/actions/workflows/example-quiet.yml/badge.svg)](.github/workflows/example-quiet.yml)
623623
624624
### Config
625625
@@ -642,7 +642,7 @@ jobs:
642642
config: pageLoadTimeout=100000,baseUrl=http://localhost:3000
643643
```
644644

645-
[![example-config](https://github.com/cypress-io/github-action/workflows/example-config/badge.svg?branch=master)](.github/workflows/example-config.yml)
645+
[![example-config](https://github.com/cypress-io/github-action/actions/workflows/example-config.yml/badge.svg)](.github/workflows/example-config.yml)
646646

647647
### Config File
648648

@@ -665,7 +665,7 @@ jobs:
665665
config-file: cypress.config-alternate.js
666666
```
667667

668-
[![example-config](https://github.com/cypress-io/github-action/workflows/example-config/badge.svg?branch=master)](.github/workflows/example-config.yml)
668+
[![example-config](https://github.com/cypress-io/github-action/actions/workflows/example-config.yml/badge.svg)](.github/workflows/example-config.yml)
669669

670670
### Parallel
671671

@@ -798,7 +798,7 @@ jobs:
798798
start-windows: npm run start:windows:server
799799
```
800800

801-
[![start example](https://github.com/cypress-io/github-action/workflows/example-start/badge.svg?branch=master)](.github/workflows/example-start.yml)
801+
[![start example](https://github.com/cypress-io/github-action/actions/workflows/example-start.yml/badge.svg)](.github/workflows/example-start.yml)
802802

803803
**Note:** A server continues to run until the end of the GitHub workflow job that started it. At the end of the job the GitHub workflow runner executes a "Complete job" phase automatically where it terminates any server processes which are still running.
804804

@@ -830,7 +830,7 @@ with:
830830
npm run web
831831
```
832832

833-
[![start example](https://github.com/cypress-io/github-action/workflows/example-start/badge.svg?branch=master)](.github/workflows/example-start.yml)
833+
[![start example](https://github.com/cypress-io/github-action/actions/workflows/example-start.yml/badge.svg)](.github/workflows/example-start.yml)
834834

835835
### Wait-on
836836

@@ -853,9 +853,9 @@ jobs:
853853
wait-on: 'http://localhost:8080'
854854
```
855855

856-
[![wait-on example](https://github.com/cypress-io/github-action/workflows/example-wait-on/badge.svg?branch=master)](.github/workflows/example-wait-on.yml)
856+
[![wait-on example](https://github.com/cypress-io/github-action/actions/workflows/example-wait-on.yml/badge.svg)](.github/workflows/example-wait-on.yml)
857857

858-
[![Webpack Dev Server example](https://github.com/cypress-io/github-action/workflows/example-webpack/badge.svg?branch=master)](.github/workflows/example-webpack.yml) (also uses `wait-on`)
858+
[![Webpack Dev Server example](https://github.com/cypress-io/github-action/actions/workflows/example-webpack.yml/badge.svg)](.github/workflows/example-webpack.yml) (also uses `wait-on`)
859859

860860
By default, `wait-on` will retry for 60 seconds. You can pass a custom timeout in seconds using `wait-on-timeout`.
861861

@@ -1135,7 +1135,7 @@ jobs:
11351135
working-directory: examples/basic-pnpm
11361136
```
11371137

1138-
[![pnpm example](https://github.com/cypress-io/github-action/workflows/example-basic-pnpm/badge.svg?branch=master)](.github/workflows/example-basic-pnpm.yml)
1138+
[![pnpm example](https://github.com/cypress-io/github-action/actions/workflows/example-basic-pnpm.yml/badge.svg)](.github/workflows/example-basic-pnpm.yml)
11391139

11401140
### pnpm workspaces
11411141

@@ -1157,7 +1157,7 @@ If you are using [pnpm workspaces](https://pnpm.io/workspaces) you need to insta
11571157
...
11581158
```
11591159

1160-
[![pnpm workspaces example](https://github.com/cypress-io/github-action/workflows/example-start-and-pnpm-workspaces/badge.svg?branch=master)](.github/workflows/example-start-and-pnpm-workspaces.yml)
1160+
[![pnpm workspaces example](https://github.com/cypress-io/github-action/actions/workflows/example-start-and-pnpm-workspaces.yml/badge.svg)](.github/workflows/example-start-and-pnpm-workspaces.yml)
11611161

11621162
See the example project [start-and-pnpm-workspaces](examples/start-and-pnpm-workspaces/) and the [example-start-and-pnpm-workspaces.yml](.github/workflows/example-start-and-pnpm-workspaces.yml) workflow for a full working example including pnpm caching.
11631163

@@ -1180,7 +1180,7 @@ jobs:
11801180
working-directory: examples/yarn-classic
11811181
```
11821182

1183-
[![Yarn classic example](https://github.com/cypress-io/github-action/workflows/example-yarn-classic/badge.svg?branch=master)](.github/workflows/example-yarn-classic.yml)
1183+
[![Yarn classic example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-classic.yml/badge.svg)](.github/workflows/example-yarn-classic.yml)
11841184

11851185
### Yarn Modern
11861186

@@ -1205,7 +1205,7 @@ jobs:
12051205
This example covers the [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) configuration `nodeLinker: node-modules` which Yarn uses by default for projects updated from Yarn Classic. For `nodeLinker: pnp` see [Yarn Plug'n'Play](#yarn-plugnplay) below.
12061206
(Note that `github-action` is not compatible with the `nodeLinker: pnpm` setting.)
12071207

1208-
[![Yarn Modern example](https://github.com/cypress-io/github-action/workflows/example-yarn-modern/badge.svg?branch=master)](.github/workflows/example-yarn-modern.yml)
1208+
[![Yarn Modern example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern.yml/badge.svg)](.github/workflows/example-yarn-modern.yml)
12091209

12101210
### Yarn Plug'n'Play
12111211

@@ -1230,7 +1230,7 @@ jobs:
12301230

12311231
This example covers the [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) configuration when `nodeLinker` is undefined or set to `nodeLinker: pnp` corresponding to Yarn Plug'n'Play. Yarn uses this by default for projects newly created with Yarn Modern.
12321232

1233-
[![Yarn Plug'n'Play example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml/badge.svg?branch=master)](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml)
1233+
[![Yarn Plug'n'Play example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml/badge.svg)](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml)
12341234

12351235
**Caution**: using the action parameter `command` causes multiple other parameters to be ignored. [See `command` section for more information.](#custom-test-command)
12361236

@@ -1257,7 +1257,7 @@ jobs:
12571257
wait-on: 'http://localhost:5000'
12581258
```
12591259

1260-
[![Yarn workspaces example](https://github.com/cypress-io/github-action/workflows/example-start-and-yarn-workspaces/badge.svg?branch=master)](.github/workflows/example-start-and-yarn-workspaces.yml)
1260+
[![Yarn workspaces example](https://github.com/cypress-io/github-action/actions/workflows/example-start-and-yarn-workspaces.yml/badge.svg)](.github/workflows/example-start-and-yarn-workspaces.yml)
12611261

12621262
### Custom cache key
12631263

@@ -1318,7 +1318,7 @@ jobs:
13181318

13191319
See the [Node.js](#nodejs) section for information about supported versions and usage of Node.js.
13201320

1321-
[![Node versions example](https://github.com/cypress-io/github-action/workflows/example-node-versions/badge.svg?branch=master)](.github/workflows/example-node-versions.yml)
1321+
[![Node versions example](https://github.com/cypress-io/github-action/actions/workflows/example-node-versions.yml/badge.svg)](.github/workflows/example-node-versions.yml)
13221322

13231323
### Split install and tests
13241324

@@ -1371,7 +1371,7 @@ If the project has many dependencies, but you want to install just Cypress you c
13711371
install: false
13721372
```
13731373

1374-
[![Install only Cypress example](https://github.com/cypress-io/github-action/workflows/example-install-only/badge.svg?branch=master)](.github/workflows/example-install-only.yml)
1374+
[![Install only Cypress example](https://github.com/cypress-io/github-action/actions/workflows/example-install-only.yml/badge.svg)](.github/workflows/example-install-only.yml)
13751375

13761376
### Timeouts
13771377

@@ -1507,7 +1507,7 @@ This is an example of using the step output `resultsUrl`:
15071507

15081508
The GitHub step output `dashboardUrl` is deprecated. Cypress Dashboard is now [Cypress Cloud](https://on.cypress.io/cloud-introduction).
15091509

1510-
[![recording example](https://github.com/cypress-io/github-action/workflows/example-recording/badge.svg?branch=master)](.github/workflows/example-recording.yml)
1510+
[![recording example](https://github.com/cypress-io/github-action/actions/workflows/example-recording.yml/badge.svg)](.github/workflows/example-recording.yml)
15111511

15121512
**Note:** every GitHub workflow step can have `outcome` and `conclusion` properties. See the GitHub [Contexts](https://docs.github.com/en/actions/learn-github-actions/contexts) documentation section [steps context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context). In particular, the `outcome` or `conclusion` value can be `success`, `failure`, `cancelled`, or `skipped` which you can use in any following steps.
15131513

@@ -1578,7 +1578,7 @@ jobs:
15781578
uses: cypress-io/github-action@v6
15791579
```
15801580

1581-
[![cron example](https://github.com/cypress-io/github-action/workflows/example-cron/badge.svg?branch=master)](.github/workflows/example-cron.yml)
1581+
[![cron example](https://github.com/cypress-io/github-action/actions/workflows/example-cron.yml/badge.svg)](.github/workflows/example-cron.yml)
15821582

15831583
### Job summary title
15841584

@@ -1644,7 +1644,7 @@ and is generally aligned with [Node.js's release schedule](https://github.com/no
16441644

16451645
`github-action` command-type options such as [`install-command`](https://github.com/cypress-io/github-action#custom-install-command), [`build`](https://github.com/cypress-io/github-action#build-app), [`start`](https://github.com/cypress-io/github-action#start-server) and [`command`](https://github.com/cypress-io/github-action#custom-test-command) are executed with the runner's version of Node.js. You can use GitHub's [actions/setup-node](https://github.com/actions/setup-node) to install an explicit Node.js version into the runner.
16461646

1647-
[![Node versions example](https://github.com/cypress-io/github-action/workflows/example-node-versions/badge.svg?branch=master)](.github/workflows/example-node-versions.yml)
1647+
[![Node versions example](https://github.com/cypress-io/github-action/actions/workflows/example-node-versions.yml/badge.svg)](.github/workflows/example-node-versions.yml)
16481648

16491649
Cypress itself runs with a fixed Node.js version specified by the [runs.using](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions) parameter of [action.yml](action.yml). `github-action@v6` uses `node20`.
16501650

@@ -1671,7 +1671,7 @@ Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to
16711671
This project is licensed under the terms of the [MIT license][license-file].
16721672

16731673
<!-- badge links follow -->
1674-
[ci-badge]: https://github.com/cypress-io/github-action/workflows/main/badge.svg?branch=master
1674+
[ci-badge]: https://github.com/cypress-io/github-action/actions/workflows/main.yml/badge.svg
16751675
[ci-workflow]: https://github.com/cypress-io/github-action/actions/workflows/main.yml
16761676
[cloud-badge]: https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/3tb7jn/master&style=flat&logo=cypress
16771677
[cloud-project]: https://cloud.cypress.io/projects/3tb7jn/runs

0 commit comments

Comments
 (0)