Skip to content

Commit e9571a0

Browse files
committed
Initial commit
1 parent 60db50d commit e9571a0

File tree

2 files changed

+2
-108
lines changed

2 files changed

+2
-108
lines changed

.github/workflows/sync-to-site.yml

Lines changed: 2 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Sync Markdown to Site Branch
1+
name: Trigger Deploy on Master Push
22

33
on:
44
push:
@@ -7,107 +7,13 @@ on:
77
workflow_dispatch:
88

99
permissions:
10-
contents: write
1110
actions: write
1211

1312
jobs:
14-
sync:
13+
trigger-deploy:
1514
runs-on: ubuntu-latest
1615
steps:
17-
- name: Checkout master branch
18-
uses: actions/checkout@v4
19-
with:
20-
ref: master
21-
fetch-depth: 0
22-
23-
- name: Set up Python
24-
uses: actions/setup-python@v5
25-
with:
26-
python-version: '3.x'
27-
28-
- name: Configure Git
29-
run: |
30-
git config user.name "github-actions[bot]"
31-
git config user.email "github-actions[bot]@users.noreply.github.com"
32-
33-
- name: Sync markdown files to site branch
34-
run: |
35-
# Fetch all branches
36-
git fetch origin
37-
38-
# Check if site branch exists
39-
if git show-ref --verify --quiet refs/remotes/origin/site; then
40-
git checkout site
41-
git pull origin site
42-
else
43-
echo "Error: site branch does not exist. Please create it first."
44-
exit 1
45-
fi
46-
47-
# Get the conversion script from site branch
48-
CONVERT_SCRIPT="scripts/convert_admonitions.py"
49-
50-
# Sync README.md from master root -> docs/index.md
51-
# Convert GitHub markdown to MkDocs format (folder links to .md links)
52-
git show master:README.md | sed \
53-
-e 's|\](mod-clk/)|](mod-clk/README.md)|g' \
54-
-e 's|\](mod-comp/)|](mod-comp/README.md)|g' \
55-
-e 's|\](mod-delay/)|](mod-delay/README.md)|g' \
56-
-e 's|\](mod-env/)|](mod-env/README.md)|g' \
57-
-e 's|\](mod-eq/)|](mod-eq/README.md)|g' \
58-
-e 's|\](mod-in-63/)|](mod-in-63/README.md)|g' \
59-
-e 's|\](mod-jacket/)|](mod-jacket/README.md)|g' \
60-
-e 's|\](mod-key/)|](mod-key/README.md)|g' \
61-
-e 's|\](mod-lpg/)|](mod-lpg/README.md)|g' \
62-
-e 's|\](mod-midi/)|](mod-midi/README.md)|g' \
63-
-e 's|\](mod-mix/)|](mod-mix/README.md)|g' \
64-
-e 's|\](mod-noise/)|](mod-noise/README.md)|g' \
65-
-e 's|\](mod-out-35/)|](mod-out-35/README.md)|g' \
66-
-e 's|\](mod-out-63/)|](mod-out-63/README.md)|g' \
67-
-e 's|\](mod-sat/)|](mod-sat/README.md)|g' \
68-
-e 's|\](mod-seq/)|](mod-seq/README.md)|g' \
69-
-e 's|\](mod-vcf/)|](mod-vcf/README.md)|g' \
70-
-e 's|\](mod-vco/)|](mod-vco/README.md)|g' \
71-
| python3 "$CONVERT_SCRIPT" > docs/index.md
72-
73-
# Sync LICENSE.md from master root -> docs/LICENSE.md
74-
git show master:LICENSE.md > docs/LICENSE.md 2>/dev/null || true
75-
76-
# List of module directories
77-
MODULES="mod-clk mod-comp mod-delay mod-env mod-eq mod-in-63 mod-jacket mod-key mod-lpg mod-midi mod-mix mod-noise mod-out-35 mod-out-63 mod-sat mod-seq mod-vcf mod-vco"
78-
79-
# Sync each module's README.md and images
80-
for mod in $MODULES; do
81-
mkdir -p "docs/$mod"
82-
83-
# Sync README.md with admonition conversion
84-
if git show "master:$mod/README.md" > /dev/null 2>&1; then
85-
git show "master:$mod/README.md" | python3 "$CONVERT_SCRIPT" > "docs/$mod/README.md"
86-
fi
87-
88-
# Sync images
89-
for ext in png jpg jpeg gif svg webp; do
90-
for file in $(git ls-tree --name-only "master:$mod/" 2>/dev/null | grep -E "\.$ext$" || true); do
91-
git show "master:$mod/$file" > "docs/$mod/$file"
92-
done
93-
done
94-
done
95-
96-
# Stage all changes
97-
git add -A
98-
99-
# Commit and push if there are changes
100-
if git diff --staged --quiet; then
101-
echo "No changes to commit"
102-
echo "CHANGES_MADE=false" >> $GITHUB_ENV
103-
else
104-
git commit -m "Sync markdown files from master"
105-
git push origin site
106-
echo "CHANGES_MADE=true" >> $GITHUB_ENV
107-
fi
108-
10916
- name: Trigger deploy workflow
110-
if: env.CHANGES_MADE == 'true'
11117
run: |
11218
gh workflow run deploy.yml --ref site
11319
env:

README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,6 @@ MICRORACK modules are compact synthesizer building blocks following the [MICRORA
66
>
77
> Any enthusiast or brand can create and distribute compatible modules — as open source projects or as closed source designs.
88
9-
## Versioning
10-
11-
For convenience MICRORACK modules are versioned in semver-like fashion (e.g. v1.0 -> v1.1) an current version is placed on the bottom side of all boards.
12-
13-
Manufacturers, enthusiasts and MICRORACK team itself may add minor improvements to some module designs over time.
14-
15-
## Consistent Platform
16-
17-
New creative modules and accessories may emerge but main system standards remains the same across manufacturers and enthusiasts.
18-
19-
MICRORACK Specification provides stable design foundations for seamless experience across designs, while building blocks variability grows with community and further enriching your setups.
20-
219
## Generators
2210

2311
- [**mod-vco**](mod-vco/) - Voltage Controlled Oscillator with LFO mode

0 commit comments

Comments
 (0)