Skip to content

add caution badge and correct numbering sequence #5152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

add caution badge and correct numbering sequence #5152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions docs/guides/cloud/projects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,29 +306,34 @@ test count to other developers viewing your project's README file.

### Create a README badge

1. In your Cypress Cloud account, select the project for which you’d like to
1. On the Project Settings page, scroll down to the README Badges section and
1. In your Cypress Cloud account, select the project for which you’d like to add
a badge.
2. On the Project Settings page, scroll down to the README Badges section and
click “Configure Badge”.
<DocsImage
src="/img/dashboard/badges/dashboard-badge-configure-button.png"
alt="README Badge configure button"
/>

- **Note**: README badges are currently only available for public projects.
:::caution

**NOTE:** README badges are currently only available for **public** projects.

:::

1. A configuration modal will appear. The Project ID will be pre-filled with the
3. A configuration modal will appear. The Project ID will be pre-filled with the
ID associated with the project you selected. You can choose to designate a
specific branch, or leave this field blank to always use the latest build in
the project.
1. Next, style your badge. Flat is the default styling and is most commonly
4. Next, style your badge. Flat is the default styling and is most commonly
used, but 5 style options are available.
1. Select the badge type to change the amount and type of information that's
5. Select the badge type to change the amount and type of information that's
displayed. Simple status will show only whether tests are passing or failing.
Detailed status will show the number of tests that were passed, failed, or
skipped. Test count will show how many tests are included in your project.
1. Once you've selected all your settings, check out the preview and make sure
6. Once you've selected all your settings, check out the preview and make sure
everything looks just the way you like it.
1. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the
7. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the
Configure Badge modal, and embed it in your project's README file for
everyone to see!

Expand Down