search

DeiC-HPC / cotainr

cotainr - a user space Apptainer/Singularity container builder.
European Union Public License 1.2
21 stars 5 forks source link

Broken link #69

Closed joasode closed 1 month ago

joasode commented 2 months ago

The Scheduled documentation link check has failed the past two weeks due to this link

akx commented 1 month ago

Sorry for the oversight!

The build did pass on the PR that added this link though, so maybe the same check should be done on PRs... https://github.com/DeiC-HPC/cotainr/commit/5b3f210e3af83a25b828f5dc6d31d762e36ea2a6

Chroxvi commented 1 month ago

No worries @akx!

But this also made me realize that we should probably run the automatic check for broken links in SCHED_docs_linkcheck.yml as part of the PR CI pipeline. I believe it would have caught this internal docs reference mistake introduced as part of #56.

We really ought to clean up our GH Actions workflow setup at some point, but for now I think it would be sufficient to add

  pull_request:
    branches:
      - main

to the on: clause of SCHED_docs_linkcheck.yml. What do you think @joasode?

joasode commented 1 month ago

I think checking for broken links in each PR is fine. However, then I think we should simply move check-docs-links: ... from SCHED_docs_linkcheck.yml into CI_pull_request.yml, and delete SCHED_docs_linkcheck.yml

Chroxvi commented 1 month ago

Fair point - when implementing my suggestion, it is not clear why we have two separate workflows anymore. As part of all the changes to the development environment and our CI/CD pipeline that we have ongoing right now, we should probably also look into reuseable workflows & composite actions. Until we have agreed on how to do that though, I would like to avoid having to change too much in the CI/CD documentation since it feels a bit like a waste of time. I still think my suggestion with just adding a "on: pull request" hook to SCHED_docs_linkcheck.yml is the solution that collides the least with the current documentation.