Skip to content

Commit b01dd42

Browse files
committed
Add mkdocs publishing of OSEP site
1 parent 2f31160 commit b01dd42

11 files changed

+265
-29
lines changed

.github/workflows/main.yml

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,39 @@ name: CI
22

33
# Controls when the workflow will run
44
on:
5-
# Triggers the workflow on push or pull request events but only for the main branch
5+
# Triggers the workflow on push events for the main branch
66
push:
77
branches: [ main ]
8-
pull_request:
9-
branches: [ main ]
8+
branches: [ mkdocs ]
109

1110
# Allows you to run this workflow manually from the Actions tab
1211
workflow_dispatch:
1312

13+
# Needs write permission to update the gh-pages branch that is used for GitHub Pages
14+
permissions:
15+
contents: write
16+
1417
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
1518
jobs:
1619
# This workflow contains a single job called "build"
17-
build:
18-
# The type of runner that the job will run on
20+
# Copied from https://squidfunk.github.io/mkdocs-material/publishing-your-site/
21+
deploy:
1922
runs-on: ubuntu-latest
20-
21-
env:
22-
STPATOOLS_VERSION: "42e07abc5510f5864aa102aa7ae1e8349911a620"
23-
STPATOOLS_REPO: "https://gitlab.com/CodethinkLabs/stpatools.git"
24-
25-
# Steps represent a sequence of tasks that will be executed as part of the job
2623
steps:
27-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
28-
- uses: actions/checkout@v2
29-
30-
# Check that YAML files are well-formed
31-
- name: YAML lint
32-
run: yamllint -d relaxed .
33-
34-
# Install specific version of ruamel.yaml required by STPAtools
35-
- name: Install ruamel.yaml
36-
run: pip3 install ruamel.yaml==0.16.7
37-
38-
# Install specific version of STPA tools from repo
39-
- name: Install STPA tools
40-
run: pip3 install "git+${{env.STPATOOLS_REPO}}@${{env.STPATOOLS_VERSION}}"
41-
42-
# Validate STPA files
43-
- name: Validate STPA files (STPA_DynMA)
44-
run: stpa-validate STPA_DynMA/*.yml
24+
- uses: actions/checkout@v4
25+
- name: Configure Git Credentials
26+
run: |
27+
git config user.name github-actions[bot]
28+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
29+
- uses: actions/setup-python@v5
30+
with:
31+
python-version: 3.x
32+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
33+
- uses: actions/cache@v4
34+
with:
35+
key: mkdocs-material-${{ env.cache_id }}
36+
path: .cache
37+
restore-keys: |
38+
mkdocs-material-
39+
- run: pip install mkdocs-material
40+
- run: mkdocs gh-deploy --force

docs/images/elisa-horizontal-color.svg

Lines changed: 190 additions & 0 deletions
Loading

docs/images/favicon.ico

4.21 KB
Binary file not shown.

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# ELISA OSEP working group
2+
3+
Welcome to the home of the Open Source Engineering Process (OSEP) working group.
4+
5+
OSEP is one of the working groups of [Enabling Linux In Safety Applications
6+
(ELISA)](https://elisa.tech/), a Linux Foundation project.

docs/stylesheets/elisa.css

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:root {
2+
3+
--md-text-font: "Open Sans";
4+
--md-code-font: "FiraCode";
5+
6+
--elisa-green: #77c046;
7+
}
8+
9+
[data-md-color-scheme="light-theme"] {
10+
color-scheme: light;
11+
12+
--md-primary-fg-color: black;
13+
--md-primary-bg-color: var(--elisa-green);
14+
15+
}
Binary file not shown.
1.39 MB
Binary file not shown.

0 commit comments

Comments
 (0)