Skip to content

add gh action to flag broken links #447

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

Merged
merged 9 commits into from
Apr 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
HUGO_VERSION=0.101.0
HUGO_VERSION="0.107.0"
DOCSY_VERSION="v0.6.0"
15 changes: 6 additions & 9 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ on:
push:
branches:
- develop
pull_request:
branches:
- develop

jobs:
deploy:
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

Expand All @@ -19,11 +16,13 @@ jobs:
run: |
. ./.env
echo "::set-output name=HUGO_VERSION::${HUGO_VERSION}"
echo "::set-output name=DOCSY_VERSION::${DOCSY_VERSION}"

- name: Add hugo nodejs dependencies
uses: actions/setup-node@v3
with:
node-version: "16"
node-version: "18"
cache: 'npm'

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
Expand All @@ -38,11 +37,9 @@ jobs:
HUGO_ENV: "production"
run: |
yarn install
hugo mod init github.com/openmodelingfoundation/openmodelingfoundation.github.io
hugo mod get github.com/google/docsy@v0.4.0
hugo --minify
hugo --minify --gc

- name: Deploy
- name: Deploy to Pages
if: github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
env:
Expand Down
51 changes: 51 additions & 0 deletions .github/workflows/run-htmltest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Run htmltest over rendered content
on:
push:
branches: [ "develop" ]
pull_request:
branches: [ "develop" ]

jobs:
htmltest:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Read .env hugo version
id: hugo-version
run: |
. ./.env
echo "::set-output name=HUGO_VERSION::${HUGO_VERSION}"
echo "::set-output name=DOCSY_VERSION::${DOCSY_VERSION}"

- name: Add hugo nodejs dependencies
uses: actions/setup-node@v3
with:
node-version: "18"
cache: 'npm'

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
# sync versions with docker-compose .env ala
# https://github.com/marketplace/actions/hugo-setup#%EF%B8%8F-read-hugo-version-from-file
hugo-version: "${{ steps.hugo-version.outputs.HUGO_VERSION }}"
extended: true

- name: Build Hugo site
env:
HUGO_ENV: "production"
run: |
yarn install
hugo --minify --gc -d $GITHUB_WORKSPACE/dist
- name: run htmltest
continue-on-error: true
uses: wjdp/htmltest-action@master
with:
config: .htmltest.yml
- name: archive htmltest results
uses: actions/upload-artifact@v3
with:
name: htmltest-report
path: tmp/.htmltest/htmltest.log
retention-days: 5
1 change: 1 addition & 0 deletions .htmltest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DirectoryPath: "dist"
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ARG HUGO_VERSION=0.101.0
ARG HUGO_VERSION=0.107.0
ARG DIST_TAG=-ext-ubuntu
FROM klakegg/hugo:${HUGO_VERSION}${DIST_TAG}

Expand Down
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ pygmentsStyle = "tango"
proxy = "direct"
[module.hugoVersion]
extended = true
min = "0.101.0"
min = "0.107.0"
[[module.imports]]
path = "github.com/google/docsy"
disable = false
Expand Down
2 changes: 1 addition & 1 deletion content/en/about/members-council/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ weight: 100
</a>

<a style=color:inherit
href="https://www.journals.elsevier.com/environmental-modelling-and-software">
href="https://www.sciencedirect.com/journal/environmental-modelling-and-software">
{{< imgproc blank Fit "200x200" >}}

<center><p><strong>Environmental Modelling and Software Journal</strong></p></center>
Expand Down
4 changes: 2 additions & 2 deletions content/en/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,5 @@ OMF Members Council Representatives are eligible to `vote` on proposed changes.
3. You can sort and filter the pull requests table by clicking on the table header names (Author, Label, Projects, etc.). For example, clicking on **_Author_** will allow you to select pull requests by a specific author. The **_sort_** menu lets you sort pull requests chronologically or by the number of comments or reactions.


For more details on creating a pull request please check out
[GitHub\'s guide for creating a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
For more details on creating a pull request refer to
[GitHub\'s guide for creating a pull request](https://docs.github.com/en/pull-requests).
2 changes: 1 addition & 1 deletion content/en/standards/documentation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ We suggest three main categories of documentation:
- Description of the model, including its purpose or goals and the type or formalism of the model (e.g., system dynamic, agent based model, machine learning), preferably accompanied by relevant keywords
- Name(s) and contact information of the developer(s)/author(s)
- Date of release
- [OSI-approved license](https://opensource.org/licenses)
- [OSI-approved license](https://choosealicense.com/)
- [How to cite the software](https://www.force11.org/software-citation-principles)
- Location where the model is posted or published (e.g. PID or DOI)
- Computer language or platform used for programming
Expand Down
6 changes: 3 additions & 3 deletions content/en/standards/reusability/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ In order to meet the ideal standards, computational models should:
Build Docker images from research code:
- stencila/dockta https://github.com/stencila/dockta
- ReproZip https://www.reprozip.org/
- SciUnit https://sciunit.run/
- SciUnit https://github.com/scidash/sciunit
- binder https://mybinder.org/
- repo2docker https://repo2docker.readthedocs.io (used by binder)

Expand All @@ -68,8 +68,8 @@ OMF may consider developing scaffolding for common modeling frameworks that redu
## Examples and References

- [Lorena Barba's reproducible workflow for computational fluid dynamics](https://doi.org/10.5281/zenodo.2642710) https://github.com/barbagroup/cloud-repro
- https://www.practicereproducibleresearch.org/
- https://reproduciblescience.org/directory/
- https://carpentries-incubator.github.io/good-enough-practices/
- http://www.practicereproducibleresearch.org/
- [Software Deposit Guidelines from SSI](https://softwaresaved.github.io/software-deposit-guidance/HowToDescribeSoftwareDeposit.html)
- [Proposed Standards for Peer-Reviewed Publication of Computer Code](https://doi.org/10.2134/agronj2015.0481)
- TODO: find or build example codebases that meet minimal and ideal standards
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ services:
- ./.git:/src/.git
- /src/themes
- /src/node_modules
- ./yarn.lock:/src/yarn.lock
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/openmodelingfoundation/openmodelingfoundation.github.io

go 1.17

require github.com/google/docsy v0.6.0 // indirect
Loading