Skip to content

Feature #584 linkcheck_job - #590

Merged
JohnHalleyGotway merged 1 commit into
developfrom
feature_584_linkcheck_job
Oct 14, 2026
Merged

JohnHalleyGotway merged 1 commit into
developfrom
feature_584_linkcheck_job

Conversation

@JohnHalleyGotway

Copy link
Copy Markdown
Contributor

Change Summary

Describe the changes proposed by this pull request:

Closes #584

Runs the link checker as its own Check Links job in the Documentation workflow, concurrently with the docs build. This is the same change made in METplus (dtcenter/METplus#3359, dtcenter/METplus@0db2fb2). Before, Check links was the last step of the Build Documentation job.

  • In .github/workflows/documentation.yaml, the new linkcheck job checks out the repository and runs dtcenter/metplus-action-linkcheck@v1 with the same inputs as before. The action sets up Python and installs the docs requirements itself, so the job needs no other steps.
  • The docs build result no longer waits for the slower link check, and a broken link now fails Check Links rather than Build Documentation.

Pull Request Testing

  • Describe testing already performed for these changes:

    Confirmed that the updated workflow file parses as YAML and defines separate documentation and linkcheck jobs. The Documentation workflow run on this PR tests the change itself.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

    Confirm that the Documentation workflow on this PR shows separate Build Documentation and Check Links jobs, and review the Linkcheck Results in the Check Links job summary.

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes] No documentation changes are needed.

  • Do these changes include sufficient testing updates? [Yes] No testing changes are needed.

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • Do these changes introduce new SonarQube findings? [No]

    If yes, please describe:

  • Please complete this pull request review by [Fill in date].

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the version that will include these changes
    Select: Coordinated METplus-X.Y Support project for bugfix releases and/or METplus-X.Y Development project for the next coordinated release
  • After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

🤖 Generated with Claude Code

…ly with the documentation build.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@JohnHalleyGotway JohnHalleyGotway added this to the METplotpy-13.0.0 milestone Oct 14, 2026
@JohnHalleyGotway JohnHalleyGotway self-assigned this Oct 14, 2026
@github-project-automation github-project-automation Bot moved this to 🩺 Needs Triage in METplus-13.0 Development Oct 14, 2026
@JohnHalleyGotway JohnHalleyGotway moved this from 🩺 Needs Triage to 🔎 In review in METplus-13.0 Development Oct 14, 2026
@JohnHalleyGotway JohnHalleyGotway linked an issue Oct 14, 2026 that may be closed by this pull request
8 of 23 tasks

@jprestop jprestop left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve this PR to break out the Check Links in a new job in the documentation workflow.

@JohnHalleyGotway
JohnHalleyGotway merged commit bc78526 into develop Oct 14, 2026
15 checks passed
@github-project-automation github-project-automation Bot moved this from 🔎 In review to 🏁 Done in METplus-13.0 Development Oct 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🏁 Done

Development

Successfully merging this pull request may close these issues.

Enhance the documentation by correcting broken links and typos

2 participants