Skip to content
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.

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

Updated README to include a note about using runner as ubuntu 22.04 #26

Merged
merged 1 commit into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
jobs:
test-check:
name: runner / linkspector (github-check)
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: ./
Expand All @@ -22,7 +22,7 @@ jobs:
test-pr-check:
if: github.event_name == 'pull_request'
name: runner / linkspector (github-pr-check)
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: ./
Expand All @@ -34,7 +34,7 @@ jobs:
test-pr-review:
if: github.event_name == 'pull_request'
name: runner / linkspector (github-pr-review)
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: ./
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[![GitHub Marketplace](https://img.shields.io/badge/GitHub%20Marketplace-action%20linkspector-brightgreen?style=for-the-badge)](https://github.com/marketplace/actions/run-linkspector-with-reviewdog)
![GitHub Release](https://img.shields.io/github/v/release/UmbrellaDocs/action-linkspector?style=for-the-badge)

<a href="https://liberapay.com/gaurav-nelson/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>

# GitHub action: Run 💀Linkspector with 🐶Reviewdog
Expand All @@ -12,13 +11,15 @@ This action runs [Linkspector](https://github.com/UmbrellaDocs/linkspector) with
1. Create a new file in your repository `.github/workflows/action.yml`.
1. Copy-paste the following workflow in your `action.yml` file:

> **IMPORTANT**: Make sure to use `ubuntu-22.04` as the runner for this action. See https://github.com/UmbrellaDocs/action-linkspector/issues/25 for more details.

```yaml
name: Linkspector
on: [pull_request]
jobs:
check-links:
name: runner / linkspector
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Run linkspector
Expand Down