-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: update README to fix tabs and link to blog post
- Loading branch information
1 parent
52d8b10
commit e25a633
Showing
1 changed file
with
29 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,14 +16,38 @@ This action works by: | |
1. Checking the supplied URL features structured data using the [Schema.org validator](https://validator.schema.org/) | ||
2. If no structured data is found, the action fails. It also fails if the structured data is invalid. | ||
|
||
For a single URL: | ||
|
||
```yml | ||
jobs: | ||
release: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: johnnyreilly/[email protected] | ||
with: | ||
urls: https://johnnyreilly.com | ||
|
||
name: Validate structured data | ||
|
||
on: | ||
pull_request: ~ | ||
push: | ||
branches: | ||
- main | ||
``` | ||
For multiple URLs: | ||
```yml | ||
jobs: | ||
release: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: johnnyreilly/[email protected] | ||
with: | ||
urls: https://johnnyreilly.com | ||
- uses: johnnyreilly/[email protected] | ||
with: | ||
urls: | | ||
https://johnnyreilly.com | ||
https://johnnyreilly.com/about | ||
name: Validate structured data | ||
|
||
|
@@ -34,6 +58,8 @@ on: | |
- main | ||
``` | ||
To read more details about this GitHub Action and how to use it, please see [this blog post](https://johnnyreilly.com/schemar-validate-structured-data-in-a-github-action). | ||
## Development | ||
To develop this GitHub Action, you'll need Node.js 20 and pnpm. Then install the dependencies: | ||
|