Skip to content
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

Move workshop to GitHub Pages #266

Merged
merged 88 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
58f353f
Add royfrancis/specky Quarto theme files
fasterius Oct 3, 2024
910d3f9
Add schedule Excel file
fasterius Oct 3, 2024
6f22068
Move specky template files to root
fasterius Oct 3, 2024
b34cda6
Update home page
fasterius Oct 3, 2024
9ff3e21
Update schedule with TRR schedule
fasterius Oct 3, 2024
896da96
Update content page
fasterius Oct 3, 2024
19197e2
Ignore Quarto hidden files
fasterius Oct 3, 2024
e098ff1
Use consolidated environment
fasterius Oct 3, 2024
adb7a91
Remove rendered HTMLs from `lectures/` directory
fasterius Oct 3, 2024
3bf844e
Fix Quarto render error of image symlink
fasterius Oct 3, 2024
87aab81
Change format of lecture renders
fasterius Oct 3, 2024
0bd9cec
Do not use end time for schedule
fasterius Oct 3, 2024
141d0dc
Ignore `_freeze` and `docs/` directories
fasterius Oct 3, 2024
3402183
Do not render tutorial/wrap-up files
fasterius Oct 3, 2024
59660d1
Convert Git tutorial to Quarto
fasterius Oct 3, 2024
e849b58
Fix schedule missing content
fasterius Oct 3, 2024
0888189
Fix titles and page titles
fasterius Oct 3, 2024
9fae283
Add TRR info to syllabus page
fasterius Oct 3, 2024
f41b45c
Add TTR info to pre-course setup page
fasterius Oct 3, 2024
77b59c9
Add introduction, markdown and take-down pages
fasterius Oct 3, 2024
159afe1
Remove old course info pages
fasterius Oct 3, 2024
2e35b81
Add GHA workflow to build and push Docker images
fasterius Oct 3, 2024
199731d
Fix minor formatting error in Dockerfile
fasterius Oct 4, 2024
e203c3d
Remove specky template files
fasterius Oct 4, 2024
2e91223
[WIP] Add GHA for deploying Specky website
fasterius Oct 4, 2024
f7ca816
Update formatting of Git page for Quarto
fasterius Oct 4, 2024
e9ab497
Fix links in Git page
fasterius Oct 4, 2024
01a5c70
Update website URL
fasterius Oct 4, 2024
96ac05b
Changed start_time and end_time to time, fixed bg color for day
royfrancis Oct 4, 2024
a5eac04
Changed start_time and end_time to time
royfrancis Oct 4, 2024
2ad975e
Added schedule table css styles
royfrancis Oct 4, 2024
ee7aff3
Merge pull request #264 from royfrancis/specky
fasterius Oct 7, 2024
ea3c836
Convert Conda pages to Specky template
fasterius Oct 15, 2024
7ae1d53
Minor formatting
fasterius Oct 15, 2024
889b085
Convert Snakemake to Specky template
fasterius Oct 15, 2024
a533e50
Fix table in Snakemake page
fasterius Oct 15, 2024
2c5c970
Convert Nextflow to Specky
fasterius Oct 15, 2024
941b5be
Convert Jupyter to Specky
fasterius Oct 15, 2024
b68e069
Convert container session to Specky
fasterius Oct 15, 2024
d44d97d
Convert Quarto to Specky
fasterius Oct 15, 2024
951ef41
Add sentence about Quarto websites
fasterius Oct 15, 2024
055ca90
Limit Canvas upload GHA to only landing page
fasterius Oct 15, 2024
ac6405a
Fix content links to pages
fasterius Oct 15, 2024
a53f72d
Add tutorial links to schedule
fasterius Oct 15, 2024
2b1629c
Add GitHub link to page headers
fasterius Oct 16, 2024
7d0b27c
[WIP] Add info page to home
fasterius Oct 16, 2024
d416528
Added child info file
royfrancis Oct 16, 2024
2dcfba5
Merge pull request #265 from royfrancis/specky
fasterius Oct 16, 2024
7b6b378
Fix licence
fasterius Oct 16, 2024
6971698
Do not freeze docs dependent on data files
fasterius Oct 16, 2024
a6047fd
Update location information
fasterius Oct 16, 2024
0d1e8ad
Rename `deploy` env/GHA to `publish` for clarity
fasterius Oct 16, 2024
9349dfa
Do not build ARM64 for the publish Docker image
fasterius Oct 16, 2024
5b3d2d3
Add `git` to publish environment
fasterius Oct 16, 2024
f0aca4c
Use a different GHA for website deployment
fasterius Oct 18, 2024
d22e77b
Rename env/GHA for clarity
fasterius Oct 18, 2024
fb9e794
Streamline Canvas upload GHA
fasterius Oct 18, 2024
be3e7d1
Switch image name for website GHA
fasterius Oct 18, 2024
45fa1cb
Add ignored paths for website building GHA
fasterius Oct 18, 2024
5fdb788
Update README
fasterius Oct 18, 2024
944c495
Update Canvas landing page
fasterius Oct 18, 2024
c9099c0
Merge branch 'gha-cleanup' into specky
fasterius Oct 19, 2024
1ea20fe
Fix internal links
fasterius Oct 21, 2024
00c20a5
Remove Canvas upload README; add script comments
fasterius Oct 21, 2024
461d965
Fix broken lecture link
fasterius Oct 21, 2024
500891b
Add {.green} class to slides SCSS
fasterius Oct 22, 2024
905b106
Add images of Cormac and Mahesh
fasterius Oct 22, 2024
29af5ad
Convert introduction lecture to Specky
fasterius Oct 22, 2024
6c395bf
Convert data management lecture to Specky
fasterius Oct 22, 2024
0745b4f
Convert Git lecture to Specky
fasterius Oct 22, 2024
8756c71
Convert Conda lecture to Specky
fasterius Oct 22, 2024
cbe4ca0
Convert Snakemake lecture to Specky
fasterius Oct 22, 2024
36577aa
Convert Nextflow lecture to Specky
fasterius Oct 22, 2024
382a18a
Convert Quarto lecture to Specky
fasterius Oct 22, 2024
c4f4d6a
Convert Jupyter lecture to Specky
fasterius Oct 22, 2024
6844861
Convert container lecture to Specky
fasterius Oct 22, 2024
194858c
Fix spelling
fasterius Oct 22, 2024
6b9aeb4
Convert putting-it-together lecture to Specky
fasterius Oct 22, 2024
40e9865
Merge branch 'devel' into specky
fasterius Oct 22, 2024
d014b97
Add missing Jupyter changes from `devel`
fasterius Oct 22, 2024
ffcb88e
Convert pre-course setup to Specky
fasterius Oct 22, 2024
abb776c
Remove unused `docker-slim` GHA
fasterius Oct 23, 2024
f895385
Update GHA versions; minor formatting of GHA
fasterius Oct 23, 2024
283f40d
Do not fail fast on Conda testing GHA
fasterius Oct 23, 2024
fff9330
Clarify GHA workflow/step names
fasterius Oct 23, 2024
005d364
Do not use mamba in GHA
fasterius Oct 23, 2024
1892bee
Do not run Conda test GHA on MacOS ARM64
fasterius Oct 23, 2024
3933524
Only run Conda tests when relevant files change
fasterius Oct 24, 2024
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
51 changes: 51 additions & 0 deletions .github/workflows/build-and-deploy-website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Build and deploy site

on:
workflow_dispatch:
push:
branches:
- main
- specky
paths-ignore:
- "README.md"
- "LICENCE.md"
- "env/"
- "pages/tools-for-reproducible-research.md"
- "tutorials/"

concurrency:
group: pages
cancel-in-progress: true

jobs:

build:
runs-on: ubuntu-latest
container: ghcr.io/nbisweden/workshop-reproducible-research/build-website:specky
steps:

- name: Checkout
uses: actions/checkout@v4

- name: Build website with Quarto
uses: quarto-dev/quarto-actions/render@v2

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/'

deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
80 changes: 80 additions & 0 deletions .github/workflows/build-images.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Build and publish Docker images

on:
push:
branches:
- main
- devel
- specky
paths:
- "env/*/Dockerfile"
- "env/*/environment.yml"

env:
REGISTRY: ghcr.io
INCLUDE_DIR: "env/"
REPOSITORY: ${{ github.repository }}

jobs:
changed-directories:
name: Get last directory name of changed files
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.changed-files.outputs.all_changed_files }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Get changed files
uses: tj-actions/changed-files@v45
id: changed-files
with:
matrix: true
dir_names: true
path: ${{ env.INCLUDE_DIR }}
dir_names_include_files: ${{ env.INCLUDE_DIR }}
dir_names_exclude_current_dir: true

build-and-push-image:
name: Build and push Docker images
runs-on: ubuntu-latest
needs: changed-directories
strategy:
fail-fast: false
matrix:
name: ${{ fromJSON(needs.changed-directories.outputs.matrix) }}
platform: [linux/amd64]
permissions:
contents: read
packages: write
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Extract metadata for Docker
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.REPOSITORY }}/${{ matrix.name }}
tags: |
type=raw,value=latest,enable=${{ endsWith(github.ref, github.event.repository.default_branch) }}
type=ref,event=branch,enable=${{ !endsWith(github.ref, github.event.repository.default_branch) }}
flavor: |
latest=false

- name: Log in to the Container registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Build and push Docker image
uses: docker/build-push-action@v6
with:
context: ${{ env.INCLUDE_DIR }}/${{ matrix.name }}
push: true
tags: ${{ steps.meta.outputs.tags }}
platforms: ${{ matrix.platform }}
33 changes: 16 additions & 17 deletions .github/workflows/canvas-upload.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
name: canvas-upload
name: Canvas upload

on:
workflow_dispatch:
branches:
- main
- devel
push:
paths:
- 'pages/*.md'
- 'pages/*/*.md'
- 'pages/upload-page-to-canvas.sh'
branches:
- main
- devel
paths:
- 'pages/tools-for-reproducible-research.md'
- 'pages/upload-page-to-canvas.sh'

jobs:
upload:
runs-on: ubuntu-latest
container: pandoc/latex
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Upload pages
env:
API_TOKEN: ${{ secrets.CANVAS_API_TOKEN }}
run: |
docker pull pandoc/latex
for FILE in $(find pages -name '*.md' ! -name "README.md");
do
bash pages/upload-page-to-canvas.sh "$FILE" "$API_TOKEN"
done
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Upload landing page to Canvas
env:
API_TOKEN: ${{ secrets.CANVAS_API_TOKEN }}
run: |
bash pages/upload-page-to-canvas.sh pages/tools-for-reproducible-research.md $API_TOKEN
14 changes: 8 additions & 6 deletions .github/workflows/docker-run.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
name: docker
name: MRSA container testing

on:
workflow_dispatch:
branches:
- main
- devel
pull_request:
branches:
- main
paths:
- 'tutorials/containers/Dockerfile'
- 'tutorials/containers/environment.yml'
- 'tutorials/containers/Snakefile'
- 'tutorials/containers/config.yml'
- 'tutorials/containers/code/*'
branches:
- main

jobs:
docker-build-and-run:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Docker build
- name: Checkout
uses: actions/checkout@v4

- name: Build and test Docker image
run: |
docker build -t my_docker_project -f tutorials/containers/Dockerfile tutorials/containers/
docker run --rm my_docker_project
docker run --rm my_docker_project
44 changes: 0 additions & 44 deletions .github/workflows/docker-slim.yml

This file was deleted.

42 changes: 33 additions & 9 deletions .github/workflows/setup.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: setup
name: Conda environment testing

on:
workflow_dispatch:
Expand All @@ -8,13 +8,30 @@ on:
pull_request:
branches:
- main
- devel
paths:
- 'tutorials/snakemake/snakefile_mrsa.smk'
- 'tutorials/snakemake/environment.yml'
- 'tutorials/nextflow/environment.yml'
- 'tutorials/nextflow/main_mrsa.yml'
- 'tutorials/nextflow/samplesheet.csv'
- 'tutorials/jupyter/environment.yml'
- 'tutorials/jupyter/references.bib'
- 'tutorials/jupyter/supplementary_material.ipynb'
- 'tutorials/quarto/environment.yml'
- 'tutorials/quarto/quarto-tutorial-example.qmd'

concurrency:
group: conda-env-test
cancel-in-progress: true

jobs:
install:
test:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ macos-latest, ubuntu-latest ]
os: [macos-latest, ubuntu-latest]
env: [snakemake, nextflow, jupyter, quarto]
include:
- env: snakemake
Expand All @@ -24,18 +41,25 @@ jobs:
- env: jupyter
cmd: jupyter nbconvert --to HTML tutorials/jupyter/supplementary_material.ipynb
- env: quarto
cmd: mamba install -c conda-forge quarto && mamba install -c conda-forge deno && export QUARTO_DENO=$(which deno) && quarto render tutorials/quarto/quarto-tutorial-example.qmd --to html
cmd: conda install -c conda-forge quarto && conda install -c conda-forge deno && export QUARTO_DENO=$(which deno) && quarto render tutorials/quarto/quarto-tutorial-example.qmd --to html
exclude:
- os: macos-latest
env: snakemake
- os: macos-latest
env: nextflow
steps:
- uses: actions/checkout@v2
- uses: conda-incubator/[email protected]
- name: Checkout
uses: actions/checkout@v4

- name: Conda setup
uses: conda-incubator/setup-miniconda@v3
with:
miniforge-variant: Mambaforge
miniforge-version: latest
activate-environment: ${{ matrix.env }}-env
environment-file: tutorials/${{ matrix.env }}/environment.yml
use-mamba: true
channel-priority: strict
- name: Test ${{ matrix.env }}

- name: Test ${{ matrix.env }} Conda environment
shell: bash -l {0}
run: |
conda list
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ snakemake/*tsv
# Quarto-related files
.quarto/
**/*_files
_freeze/
docs/

# VScode
.vscode

/.quarto/
22 changes: 22 additions & 0 deletions 404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
pagetitle: "404: Page not found"
subtitle: ""
date: ""
toc: false
sidebar: false
number-sections: false
format: html
execute:
freeze: false
---

::: {style="text-align: center;"}

[404]{.fourofour}

# 404: Page not found

It seems like you have stumbled upon a page that doesn't exist.
Please check your URL again.

:::
Loading