Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
50 changes: 50 additions & 0 deletions .github/workflows/ci-linkchecks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Linkcheck

on:
workflow_dispatch:
schedule:
- cron: "00 06 * * *"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
linkChecker:
runs-on: ubuntu-latest
permissions:
issues: write # required for peter-evans/create-issue-from-file

steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
persist-credentials: false

- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411
with:
token: ${{secrets.GITHUB_TOKEN}}
fail: false
args: |
--verbose
--max-concurrency 1
'./docs/**/*.rst'
'./lib/**/*.py'

- name: Create Issue From File
if: ${{ fromJSON(steps.lychee.outputs.exit_code) != 0 }}
uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710
with:
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: |
Bot
Type: Documentation
Type: Bug

- name: Fail Workflow On Link Errors
if: ${{ fromJSON(steps.lychee.outputs.exit_code) != 0 }}
run:
exit ${{ fromJSON(steps.lychee.outputs.exit_code) }}
2 changes: 1 addition & 1 deletion .github/workflows/ci-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
matrix:
os: ["ubuntu-latest"]
python-version: ["3.14"]
session: ["doctest", "linkcheck"]
session: ["doctest"]
iris-source : ["conda-forge"]
include:
- os: "ubuntu-latest"
Expand Down
10 changes: 10 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Change-log entries reference GitHub user accounts, which are common enough
# to trigger GitHub rate limiting.
https://github.com/[^/]*$

# GitHub seems especially keen to rate-limit "blob" URLs.
# (maybe because these are especially associated with abuse?)
https://github.com/[^/]*/[^/]*/blob/.*

# Returns 403 when accessed from GitHub Actions
https://stackoverflow.com
12 changes: 12 additions & 0 deletions docs/reference/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
Release Notes
=============

What's new in iris-grib v0.23.0
-------------------------------

:Release: 0.23.0
:Date: TBC

Internal
^^^^^^^^
* `@trexfeathers <https://github.com/trexfeathers>`_ switched the link check CI
to be the standard SciTools overnight job using Lychee.
`(PR#795) <https://github.com/SciTools/iris-grib/pull/795>`_


What's new in iris-grib v0.22.0
-------------------------------
Expand Down
26 changes: 0 additions & 26 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -319,31 +319,5 @@ def doctest(session: nox.sessions.Session):
)


@nox.session(python=PY_VER, venv_backend="conda")
def linkcheck(session: nox.sessions.Session):
"""
Perform iris-grib doc link check.

Parameters
----------
session: object
A `nox.sessions.Session` object.

"""
prepare_venv(session)
session.cd("docs")
session.run(
"make",
"clean",
"html",
external=True,
)
session.run(
"make",
"linkcheck",
external=True,
)


if __name__ == "__main__":
nox.main()
Loading