Skip to content

Commit

Permalink
Add github action to check links
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel committed Jun 19, 2024
1 parent 0536329 commit e97a849
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 2 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# .github/workflows/run-htmltest.yml
# (c) 2021 Robb Romans
#
# Run htmltest link checker on generated HTML output in dist/
# https://github.com/wjdp/htmltest
#
name: run-htmltest
concurrency:
group: pullrequest-untrusted-htmltest-${{ github.event.number }}
cancel-in-progress: true
on: pull_request
jobs:
htmltest:
runs-on: ubuntu-large
container:
image: ghcr.io/cirruslabs/flutter:latest
steps:
- name: Checkout Code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v3
with:
go-version: stable
cache: true
- name: Install doc2go
run: go install go.abhg.dev/doc2go@latest
- name: Generate API reference
run: doc2go -out www ./...
- name: Test HTML
# https://github.com/wjdp/htmltest-action/
# Don't fail the build on broken links
continue-on-error: false
uses: wjdp/htmltest-action@master
with:
config: .htmltest.yml
- name: Archive htmltest results
uses: actions/upload-artifact@v3
# Note: Set ACTIONS_RUNTIME_TOKEN env variable to test with nektos/act
with:
name: htmltest-report
path: tmp/.htmltest/htmltest.log
retention-days: 7 # Default is 90 days
17 changes: 17 additions & 0 deletions .htmltest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
DirectoryPath: "www"
EnforceHTTPS: true
IgnoreEmptyHref: true
IgnoreInternalEmptyHash: true
IgnoreDirectoryMissingTrailingSlash: false
IgnoreURLs:
- "app.viam.com"
- "fonts.gstatic.com"
- "contributor-covenant.org"
IgnoreDirs:
- "lib"
CacheExpires: "6h"
# IgnoreDirs: - if we need to ever ignore files
CheckInternal: false
CheckDoctype: false
CheckScripts: false
FileExtension: ".html"
2 changes: 1 addition & 1 deletion spatialmath/rotationMatrix.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (rm *RotationMatrix) AxisAngles() *R4AA {
}

// Quaternion returns orientation in quaternion representation.
// reference: http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm
// reference: https://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm
func (rm *RotationMatrix) Quaternion() quat.Number {
var q quat.Number
m := rm.mat
Expand Down
2 changes: 1 addition & 1 deletion spatialmath/rotationMatrix_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (

func TestQuaternionConversion(t *testing.T) {
// Test that conversion to rotation matrix to quaternion is correct
// http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/examples/index.htm
// https://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/examples/index.htm
cos45 := 0.7071067811865476
cases := []struct {
input [9]float64
Expand Down

0 comments on commit e97a849

Please sign in to comment.