Skip to content
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
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SCM syntax highlighting & preventing 3-way merges
pixi.lock merge=binary linguist-language=YAML linguist-generated=true
33 changes: 14 additions & 19 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,23 @@ on:
jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: GitHub Tag Name example
run: |
echo "Status: *release* $GITHUB_REF_NAME" > release.md

- uses: mamba-org/setup-micromamba@v2
- uses: actions/checkout@v4
- uses: prefix-dev/setup-pixi@v0.8.13
with:
environment-file: environment.yml
init-shell: >-
bash
cache-environment: true
post-cleanup: 'all'
- name: Install tinytex
shell: micromamba-shell {0}
run: quarto install tinytex
- name: Build docs
shell: micromamba-shell {0}
run: quarto render .

manifest-path: pixi.toml
pixi-version: v0.49.0
cache: true
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
# - run: |
# quarto install tinytex
# shell: pixi run bash -e {0} # https://pixi.sh/latest/advanced/github_actions/#custom-shell-wrapper
- run: pixi run install-tinytex
- run: pixi run build-docs

- name: Push docs to gh-pages
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: _site
folder: _site
47 changes: 15 additions & 32 deletions .github/workflows/github-actions-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,37 +14,20 @@ jobs:
Check-Duplicates:

runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9"]

steps:
- uses: actions/checkout@v2

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
working-directory: ./tools/

- name: Check for duplicates
run: |
python check-duplicates.py --input ../BDNS_Abbreviations_Register.csv
working-directory: ./tools/

- name: Check sorted
run: |
python tools/sort.py

- name: validate ifc4_3 mappings
run: |
python tools/validate_ifc4_3.py

- name: validate unique ifc4_3 mappings
run: |
python tools/validate_unique_default_mappings.py
- uses: actions/checkout@v4
- uses: prefix-dev/setup-pixi@v0.8.13
with:
manifest-path: pixi.toml
pixi-version: v0.49.0
cache: true
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}

- run: pixi run check-duplicates

- run: pixi run check-sort

- run: pixi run check-ifc4_3

- run: pixi run check-unique-ifc4_3-mappings
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
.idea

/.quarto/
/_site/*
/_site/*
# pixi environments
.pixi
*.egg-info
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,18 @@ This repo contains the source markdown files which build the published [BDNS spe
The website is built using the [Quarto](https://quarto.org/) publishing system.
To test building the documentation locally:

Install [mamba or micromamba](https://mamba.readthedocs.io/en/latest/index.html) then run the commands below line-by-line.
Install [pixi](https://pixi.sh/latest/installation/) then run the commands below line-by-line.

```console
git clone https://github.com/theodi/BDNS.git
cd BDNS
mamba env create -f environment.yml
quarto install tinytex # required for generating pdf docs
quarto render .
pixi install # install environment dependencies
pixi run install-tinytex # install tinytex for pdf generation
pixi run # this will list all the available commands

# e.g. to build the docs
pixi run build-docs

# to check for duplicate abbreviations
pixi run check-duplicates
```
13 changes: 11 additions & 2 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ project:
type: website

website:
repo-url: https://github.com/theodi/BDNS
repo-actions: [edit, source, issue]
navbar:

left:
- href: index.qmd
- href: BDNS_Governance_model.md
Expand All @@ -18,11 +21,17 @@ website:
- href: BDNS_Abbreviations_Core.qmd
text: Abbreviations Core

right:
- icon: github
href: https://github.com/theodi/BDNS
aria-label: GitHub

format:
html:
theme: cosmo
css: styles.css
toc: true

theme:
light: flatly
dark: darkly


Loading