Skip to content

Commit

Permalink
Fixed link checker (#1574)
Browse files Browse the repository at this point in the history
* Update container image for CI

* Re-enable for push (good to test)

* Restructure GH action

Instead of using a custom container, use the base Ubuntu
release and the GH actions needed to setup ruby, install Jekyll and
then run it.

* Exact ruby version

* Use ruby setup bundler install

Simplify Gemfile

* Update _config.yml

Change site.name to site.title and also update description

* Add an intentional bad link

* Further link tests

* Remove test links
  • Loading branch information
graeme-a-stewart authored Aug 27, 2024
1 parent e0c286e commit ff9b0cc
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 25 deletions.
24 changes: 13 additions & 11 deletions .github/workflows/link_check.yaml
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
name: link_checker
name: Check Markdown links

on: [push, pull_request]

jobs:
check_new_links:
name: link_checker
markdown-link-check:
runs-on: ubuntu-latest
container: hepsoftwarefoundation/hsf-jekyll
strategy:
fail-fast: false
steps:
- name: checkout repository
- name: Checkout
uses: actions/checkout@v4

- name: jekyll build
run: |
bundler exec jekyll build
- name: actions link checker
- name: Ruby Install
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2'
bundler-cache: true
- name: Jekyll Build
run: bundler exec jekyll build
- name: Check Links
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: '.github/config/mdcheck.json'
Expand Down
13 changes: 1 addition & 12 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
source "https://rubygems.org"

gem 'jekyll-feed'
gem "github-pages", ">= 150"
gem "html-proofer"

# Suggested by Jekyll
gem 'wdm', '>= 0.1.0' if Gem.win_platform?

# Required on Windows
gem 'tzinfo-data' if Gem.win_platform?

# Needed for Ruby > 3.1? due to changed dependencies
gem 'webrick'
gem 'github-pages', group: :jekyll_plugins
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: HEP Software Foundation Newsletter
description: News from the HEP Software Foundation
title: HEP Software Foundation
description: HEP Software Foundation Website
url: http://www.hepsoftwarefoundation.org
excerpt_separator: <!--more-->
timezone: Europe/Paris
Expand Down

0 comments on commit ff9b0cc

Please sign in to comment.