readme helical
This commit is contained in:
parent
3933d65303
commit
ee33469295
|
@ -2,15 +2,17 @@
|
|||
# format:
|
||||
# - source: path/to/markdown/file.md
|
||||
# target: Wiki-Page-Name
|
||||
|
||||
mappings:
|
||||
- source: benchmarks/rotatingDrum/readme.md
|
||||
- source: benchmarks/readme.md
|
||||
target: Performance-of-phasicFlow
|
||||
- source: benchmarks/helicalMider/readme.md
|
||||
target: Helical-Mixer-Benchmark
|
||||
- source: benchmarks/rotatingDrum/readme.md
|
||||
target: Rotating-Drum-Benchmark
|
||||
- source: doc/mdDocs/howToBuild-V1.0.md
|
||||
target: How-to-build-PhasicFlow‐v‐1.0
|
||||
- source: tutorials/README.md
|
||||
target: Tutorials
|
||||
- source: doc/mdDocs/phasicFlowFeatures.md
|
||||
target: Features-of-PhasicFlow
|
||||
|
||||
# Add more mappings as needed
|
|
@ -1,6 +1,15 @@
|
|||
name: Sync-Wiki
|
||||
|
||||
on: push
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- "**/*.md"
|
||||
- ".github/workflows/sync-wiki.yml"
|
||||
- ".github/workflows/markdownList.yml"
|
||||
- ".github/scripts/sync-wiki.py"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
sync-wiki:
|
||||
|
@ -10,14 +19,12 @@ jobs:
|
|||
uses: actions/checkout@v3
|
||||
with:
|
||||
path: repo
|
||||
|
||||
- name: Checkout Wiki
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
repository: ${{ github.repository }}.wiki
|
||||
path: wiki
|
||||
continue-on-error: true
|
||||
|
||||
- name: Create Wiki Directory if Not Exists
|
||||
run: |
|
||||
if [ ! -d "wiki" ]; then
|
||||
|
@ -28,21 +35,17 @@ jobs:
|
|||
git config user.email "${{ github.actor }}@users.noreply.github.com"
|
||||
git remote add origin "https://github.com/${{ github.repository }}.wiki.git"
|
||||
fi
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.10'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip install pyyaml
|
||||
|
||||
- name: Sync markdown files to Wiki
|
||||
run: |
|
||||
python $GITHUB_WORKSPACE/repo/.github/scripts/sync-wiki.py
|
||||
env:
|
||||
GITHUB_REPOSITORY: ${{ github.repository }}
|
||||
|
||||
- name: Push changes to wiki
|
||||
run: |
|
||||
cd wiki
|
||||
|
@ -50,7 +53,7 @@ jobs:
|
|||
git config user.email "${{ github.actor }}@users.noreply.github.com"
|
||||
git add .
|
||||
if git status --porcelain | grep .; then
|
||||
git commit -m "Auto sync wiki from main repository"
|
||||
git commit -m "Auto sync wiki from main repository"
|
||||
git push --set-upstream https://${{ github.actor }}:${{ github.token }}@github.com/${{ github.repository }}.wiki.git master -f
|
||||
else
|
||||
echo "No changes to commit"
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
# Helical Mixer Benchmark (phasicFlow v-1.0)
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
# Benchmarks
|
||||
|
||||
Benchmakrs has been done on two different simulations: a simulation with simple geometry (rotating drum) and a simulation with complex geometry (helical mixer).
|
||||
|
||||
- [rotating drum](./rotatingDrum/readme.md)
|
||||
- [helical mixer](./helicalMixer/readme.md)
|
Loading…
Reference in New Issue