https://github.com/peaceiris/actions-hugo-link-check

GitHub Actions to check broken links for Hugo
https://github.com/peaceiris/actions-hugo-link-check

github-actions hugo

Last synced: over 1 year ago
JSON representation

GitHub Actions to check broken links for Hugo

• Host: GitHub
• URL: https://github.com/peaceiris/actions-hugo-link-check
• Owner: peaceiris
• License: mit
• Archived: true
• Created: 2019-05-14T08:01:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-19T15:05:25.000Z (almost 7 years ago)
• Last Synced: 2024-10-30T07:47:16.196Z (over 1 year ago)
• Topics: github-actions, hugo
• Language: Dockerfile
• Homepage:
• Size: 130 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![license](https://img.shields.io/github/license/peaceiris/actions-hugo-link-check.svg)](https://github.com/peaceiris/actions-hugo-link-check/blob/master/LICENSE)

[![release](https://img.shields.io/github/release/peaceiris/actions-hugo-link-check.svg)](https://github.com/peaceiris/actions-hugo-link-check/releases/latest)

[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-hugo-link-check.svg)](https://github.com/peaceiris/actions-hugo-link-check/releases)



## GitHub Actions to check broken links for Hugo

- [gohugoio/hugo: The world’s fastest framework for building websites.](https://github.com/gohugoio/hugo)

- [raviqqe/muffet: Fast website link checker in Go](https://github.com/raviqqe/muffet)

This action runs the following commands.

```sh

hugo server ${HUGO_OPTIONS} &

# wait for starting hugo server (time out 5 min)

muffet ${OPTIONS} http://localhost:1313

```

## Getting started

### Create `main.workflow`

```hcl

workflow "Main workflow" {

  on = "push"

  resolves = ["hugo-link-check"]

}

action "hugo-link-check" {

  uses = "peaceiris/actions-hugo-link-check@v0.56.3"

  env = {

    HUGO_OPTIONS = "--buildDrafts"

    OPTIONS = "-e 'http://localhost:8000'"

  }

}

```

## License

[MIT License - peaceiris/actions-hugo-link-check]

[MIT License - peaceiris/actions-hugo-link-check]: https://github.com/peaceiris/actions-hugo-link-check/blob/master/LICENSE

## About the author

- [peaceiris's homepage](https://peaceiris.com/)