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

CI: Remove the deprecated lychee option and specify the report file name in the Check Links workflow #3297

Merged
merged 1 commit into from
Jun 20, 2024

Conversation

seisman
Copy link
Member

@seisman seisman commented Jun 20, 2024

The "Check Links" workflow fails (https://github.com/GenericMappingTools/pygmt/actions/runs/9535958882), because:

  • We check out the repository and documentation into separate subdirectories
  • gh only works for a git repository, so we need to change into the repository directory
  • The lychee action is run in the github workspace directory.

Thus, the lychee output file lychee/out.md is also relative to the workspace directory. When running gh issue create, we should use the path ../lychee/out.md, but it's not readable.

In this PR, we explicitly set output: /tmp/lychee-out.md so that we can use the full path.

The workflow also reports a warning:

[WARN ] WARNING: `--exclude-mail` is deprecated and will soon be removed; E-Mail is no longer checked by default. Use `--include-mail` to enable E-Mail checking.

@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Jun 20, 2024
@seisman seisman added this to the 0.13.0 milestone Jun 20, 2024
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Tested by manually triggering a run using workflow dispatch at https://github.com/GenericMappingTools/pygmt/actions/runs/9591086154/job/26447448448, and it worked (created an issue at #3298).

@seisman seisman merged commit ec578e4 into main Jun 20, 2024
9 checks passed
@seisman seisman deleted the ci/check-links branch June 20, 2024 03:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants