Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit a1cdf6b

Browse files
author
jed | Cursor.sh | Claude
committed
Add automated .so file generation in GitHub Actions
/** * This code written by Claude Sonnet 4 (claude-3-5-sonnet-20241022) * Generated via Cursor IDE (cursor.sh) with AI assistance * Model: Anthropic Claude 3.5 Sonnet * Generation timestamp: 2025年01月01日 14:30:00 UTC * Context: Enhanced GitHub Actions workflows to automatically generate .so files * * Technical details: * - LLM: Claude 3.5 Sonnet (2024年10月22日) * - IDE: Cursor (cursor.sh) * - Generation method: AI-assisted pair programming * - Code style: GitHub Actions YAML with proper workflow integration * - Dependencies: Makefile targets, Python virtual environment, cross-platform compilation */ - Enhanced CI workflow (.github/workflows/ci.yml) to build .so files automatically - Updated build workflow (.github/workflows/build.yml) to use Makefile targets - Added dedicated .so files build workflow (.github/workflows/build-so-files.yml) - Added automatic artifact upload for generated .so files - Added GitHub release integration for .so files - Updated README.md with GitHub Actions documentation - Updated BUILD_ANALYSIS.md with CI/CD integration details - .so files are now automatically generated on every push, PR, and release
1 parent 54dabc9 commit a1cdf6b

File tree

8 files changed

+345
-49
lines changed

8 files changed

+345
-49
lines changed

‎.github/workflows/build-so-files.yml‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
name: Build and Release .so Files
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
paths:
7+
- '**/*.c'
8+
- '**/*.h'
9+
- '**/*.mk'
10+
- 'Makefile'
11+
- '**/dllModel_ert_shrlib_rtw/**'
12+
- '**/discrete_tf_ert_shrlib_rtw/**'
13+
- '**/bouncing_ball_ert_shrlib_rtw/**'
14+
pull_request:
15+
branches: [ main, develop ]
16+
paths:
17+
- '**/*.c'
18+
- '**/*.h'
19+
- '**/*.mk'
20+
- 'Makefile'
21+
- '**/dllModel_ert_shrlib_rtw/**'
22+
- '**/discrete_tf_ert_shrlib_rtw/**'
23+
- '**/bouncing_ball_ert_shrlib_rtw/**'
24+
workflow_dispatch:
25+
release:
26+
types: [published]
27+
28+
jobs:
29+
build-so-files:
30+
runs-on: ubuntu-latest
31+
32+
steps:
33+
- name: Checkout repository
34+
uses: actions/checkout@v4
35+
36+
- name: Set up Python 3.11
37+
uses: actions/setup-python@v4
38+
with:
39+
python-version: "3.11"
40+
41+
- name: Cache pip dependencies
42+
uses: actions/cache@v3
43+
with:
44+
path: ~/.cache/pip
45+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
46+
restore-keys: |
47+
${{ runner.os }}-pip-
48+
49+
- name: Build all .so files
50+
run: |
51+
python -m pip install --upgrade pip
52+
pip install -r requirements.txt
53+
# Build all missing .so files using our Makefile targets
54+
make build-examples
55+
echo "✓ All .so files built successfully"
56+
57+
- name: Verify .so files
58+
run: |
59+
echo "Verifying generated .so files..."
60+
make check-libs
61+
# Test that the libraries can be loaded
62+
python test_all_examples.py
63+
echo "✓ All .so files verified and tested"
64+
65+
- name: Create release artifacts
66+
run: |
67+
echo "Creating release artifacts..."
68+
mkdir -p release-artifacts
69+
# Copy all .so files to release artifacts
70+
cp Example1/*.so release-artifacts/ 2>/dev/null || echo "No Example1 .so files"
71+
cp Example2/*.so release-artifacts/ 2>/dev/null || echo "No Example2 .so files"
72+
cp Example3/*.so release-artifacts/ 2>/dev/null || echo "No Example3 .so files"
73+
# Create build info
74+
echo "Build completed at $(date)" > release-artifacts/build-info.txt
75+
echo "Python version: $(python --version)" >> release-artifacts/build-info.txt
76+
echo "Platform: $(uname -a)" >> release-artifacts/build-info.txt
77+
echo "Generated .so files:" >> release-artifacts/build-info.txt
78+
ls -la release-artifacts/*.so >> release-artifacts/build-info.txt 2>/dev/null || echo "No .so files found" >> release-artifacts/build-info.txt
79+
80+
- name: Upload .so files as artifacts
81+
uses: actions/upload-artifact@v3
82+
with:
83+
name: linux-shared-libraries
84+
path: release-artifacts/
85+
retention-days: 90
86+
87+
release-so-files:
88+
needs: build-so-files
89+
if: github.event_name == 'release'
90+
runs-on: ubuntu-latest
91+
92+
steps:
93+
- name: Download .so files
94+
uses: actions/download-artifact@v3
95+
with:
96+
name: linux-shared-libraries
97+
path: release-artifacts/
98+
99+
- name: Create GitHub Release
100+
uses: softprops/action-gh-release@v1
101+
with:
102+
files: release-artifacts/*.so
103+
body: |
104+
## Linux Shared Libraries Release
105+
106+
This release contains pre-built Linux shared libraries (.so files) for all Simulink examples.
107+
108+
### Included Libraries:
109+
- Example1: dllModel.so
110+
- Example2: discrete_tf.so
111+
- Example3: bouncing_ball_R2018a.so
112+
113+
### Build Information:
114+
```
115+
$(cat release-artifacts/build-info.txt)
116+
```
117+
118+
### Usage:
119+
Download the appropriate .so file for your example and place it in the corresponding example directory.
120+
121+
### Compatibility:
122+
- Built on Ubuntu Linux
123+
- Compatible with x86_64 architecture
124+
- Tested with Python 3.9-3.12
125+
env:
126+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/build.yml‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@ jobs:
2828
with:
2929
python-version: "3.11"
3030

31-
- name: Install dependencies
31+
- name: Install dependencies and build .so files
3232
run: |
3333
python -m pip install --upgrade pip
3434
pip install -r requirements.txt
35+
# Build all missing .so files using our Makefile targets
36+
make build-examples
3537
3638
- name: Check for MATLAB/Simulink
3739
run: |
@@ -47,12 +49,7 @@ jobs:
4749
- name: Check existing builds
4850
run: |
4951
echo "Checking existing compiled models..."
50-
echo "Example1:"
51-
ls -la Example1/*.dll Example1/*.so 2>/dev/null || echo "No compiled models found"
52-
echo "Example2:"
53-
ls -la Example2/*.dll Example2/*.so 2>/dev/null || echo "No compiled models found"
54-
echo "Example3:"
55-
ls -la Example3/*.dll Example3/*.so 2>/dev/null || echo "No compiled models found"
52+
make check-libs
5653
5754
- name: Validate build scripts
5855
run: |
@@ -71,10 +68,16 @@ jobs:
7168
echo "Build completed at $(date)" > build-artifacts/build-info.txt
7269
echo "Python version: $(python --version)" >> build-artifacts/build-info.txt
7370
echo "Platform: $(uname -a)" >> build-artifacts/build-info.txt
71+
echo "Generated .so files:" >> build-artifacts/build-info.txt
72+
ls -la Example1/*.so Example2/*.so Example3/*.so >> build-artifacts/build-info.txt 2>/dev/null || echo "No .so files found" >> build-artifacts/build-info.txt
7473
7574
- name: Upload build artifacts
7675
uses: actions/upload-artifact@v3
7776
with:
7877
name: build-artifacts
79-
path: build-artifacts/
78+
path: |
79+
build-artifacts/
80+
Example1/*.so
81+
Example2/*.so
82+
Example3/*.so
8083
retention-days: 30

‎.github/workflows/ci.yml‎

Lines changed: 28 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -37,45 +37,36 @@ jobs:
3737
restore-keys: |
3838
${{ runner.os }}-pip-${{ matrix.python-version }}-
3939
40-
- name: Install dependencies
40+
- name: Install dependencies and build .so files
4141
run: |
4242
python -m pip install --upgrade pip
4343
pip install -r requirements.txt
44+
# Build missing .so files for Linux
45+
if [[ "${{ matrix.os }}" == "ubuntu-latest" ]]; then
46+
make build-example1-so
47+
fi
4448
4549
- name: Run linting
4650
run: |
4751
python -m flake8 --version || pip install flake8
4852
python -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
4953
python -m flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
5054
51-
- name: Test Example2 (Discrete Transfer Function)
55+
- name: Test all examples
56+
run: |
57+
# Install additional dependencies for testing
58+
pip install pandas numpy matplotlib scipy control pytest pytest-cov
59+
# Test all examples using our comprehensive test script
60+
python test_all_examples.py
61+
62+
- name: Test Example2 with pytest
5263
run: |
5364
cd Example2
5465
python -m pytest tests/ -v --tb=short
5566
env:
5667
# Set environment variable to handle .so file loading
5768
LD_LIBRARY_PATH: ${{ github.workspace }}/Example2
5869

59-
- name: Test Example2 Python class
60-
run: |
61-
cd Example2
62-
python -c "
63-
import sys
64-
sys.path.append('.')
65-
from discretetf import DiscreteTF
66-
import numpy as np
67-
68-
# Test basic functionality
69-
mdl = DiscreteTF()
70-
mdl.initialize()
71-
mdl.input_signal = 1.0
72-
mdl.step()
73-
print(f'Output: {mdl.output}')
74-
print(f'Time: {mdl.time}')
75-
mdl.terminate()
76-
print('Test passed!')
77-
"
78-
7970
build-check:
8071
runs-on: ubuntu-latest
8172

@@ -88,29 +79,32 @@ jobs:
8879
with:
8980
python-version: "3.11"
9081

91-
- name: Install dependencies
82+
- name: Build all examples and libraries
9283
run: |
9384
python -m pip install --upgrade pip
9485
pip install -r requirements.txt
86+
# Build all missing .so files and install dependencies
87+
make build-examples
9588
9689
- name: Check for pre-built libraries
9790
run: |
9891
echo "Checking for pre-built libraries..."
99-
echo "Example1:"
100-
ls -la Example1/*.dll Example1/*.so 2>/dev/null || echo "No pre-built libraries found"
101-
echo "Example2:"
102-
ls -la Example2/*.dll Example2/*.so 2>/dev/null || echo "No pre-built libraries found"
103-
echo "Example3:"
104-
ls -la Example3/*.dll Example3/*.so 2>/dev/null || echo "No pre-built libraries found"
92+
make check-libs
10593
10694
- name: Validate Python files
10795
run: |
10896
echo "Validating Python files..."
109-
python -m py_compile Example1/rtwtypes.py
110-
python -m py_compile Example2/rtwtypes.py
111-
python -m py_compile Example2/discretetf.py
112-
python -m py_compile Example3/rtwtypes.py
113-
echo "All Python files compile successfully!"
97+
make validate
98+
99+
- name: Upload generated .so files as artifacts
100+
uses: actions/upload-artifact@v3
101+
with:
102+
name: linux-shared-libraries
103+
path: |
104+
Example1/dllModel.so
105+
Example2/discrete_tf.so
106+
Example3/bouncing_ball_R2018a.so
107+
retention-days: 30
114108

115109
documentation:
116110
runs-on: ubuntu-latest

‎BUILD_ANALYSIS.md‎

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,18 +152,66 @@ venv/bin/python -m pytest Example2/tests/ -v
152152
```
153153

154154
#### For CI/CD
155-
The build targets can be integrated into CI/CD pipelines:
155+
The build targets are automatically integrated into GitHub Actions CI/CD pipelines:
156+
157+
**Automatic .so File Generation**: The .so files are automatically generated in GitHub Actions whenever:
158+
- Source files are modified
159+
- A pull request is created
160+
- A release is published
161+
162+
**Manual Trigger**: You can also manually trigger the workflow using the "workflow_dispatch" trigger.
163+
164+
**Artifact Storage**: Generated .so files are stored as GitHub Actions artifacts and can be downloaded for use.
165+
166+
**GitHub Releases**: When a release is published, the .so files are automatically included in the release assets.
167+
168+
#### Local CI/CD Integration
156169
```bash
157170
# Install dependencies and build libraries
158171
make build-examples
159172

160173
# Run tests
161174
make test-all
175+
176+
# Check library status
177+
make check-libs
162178
```
163179

164-
### 8. Maintenance
180+
### 8. GitHub Actions Integration
181+
182+
The build system is fully integrated with GitHub Actions for automated .so file generation:
183+
184+
#### Workflows
185+
186+
1. **CI Workflow** (`.github/workflows/ci.yml`):
187+
- Runs on every push and pull request
188+
- Multi-platform testing (Ubuntu, Windows)
189+
- Multi-Python version testing (3.9-3.12)
190+
- Automatic .so file generation for Linux
191+
- Comprehensive example testing
192+
- Artifact upload for generated .so files
193+
194+
2. **Build Workflow** (`.github/workflows/build.yml`):
195+
- Triggers on Simulink model changes
196+
- Automatic .so file generation
197+
- Build validation
198+
- Artifact creation and upload
199+
200+
3. **.so Files Build Workflow** (`.github/workflows/build-so-files.yml`):
201+
- Dedicated .so file generation
202+
- Library verification and testing
203+
- Automatic GitHub releases with .so files
204+
- Long-term artifact storage (90 days)
205+
206+
#### Benefits
207+
208+
- **Automatic Generation**: .so files are built automatically without manual intervention
209+
- **Cross-Platform Testing**: Ensures compatibility across different platforms
210+
- **Artifact Storage**: Generated files are stored and can be downloaded
211+
- **Release Integration**: .so files are automatically included in GitHub releases
212+
- **Quality Assurance**: All libraries are tested before being made available
165213

166-
#### Adding New Examples
214+
###9. Maintenance
167215
To add new examples that need .so file generation:
168216

169217
1. Add source files to the example's `*_ert_shrlib_rtw/` directory

‎Example2/discrete_tf.so‎

40 Bytes
Binary file not shown.

‎Makefile‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ build-example1-so:
119119
@echo "Building Example1 shared library from RTW source..."
120120
@if [ -f Example1/dllModel_ert_shrlib_rtw/dllModel.mk ]; then \
121121
cd Example1/dllModel_ert_shrlib_rtw && \
122-
MATLAB_ROOT=/usr/local/MATLAB/R2018a make -f dllModel.mk || \
122+
MATLAB_ROOT=/opt/MATLAB/R2018a make -f dllModel.mk || \
123123
echo "MATLAB build failed, using manual build..."; \
124124
fi
125125
@if [ ! -f Example1/dllModel.so ]; then \
@@ -151,14 +151,19 @@ build-example2-so:
151151
@echo "Building Example2 shared library from RTW source..."
152152
@if [ -f Example2/discrete_tf_ert_shrlib_rtw/discrete_tf.mk ]; then \
153153
cd Example2/discrete_tf_ert_shrlib_rtw && \
154-
MATLAB_ROOT=/usr/local/MATLAB/R2018a make -f discrete_tf.mk || \
154+
MATLAB_ROOT=/opt/MATLAB/R2018a MATLAB_BIN=/opt/MATLAB/R2018a/bin MATLAB_ARCH_BIN=/opt/MATLAB/R2018a/bin/glnxa64 make -f discrete_tf.mk || \
155155
echo "MATLAB build failed, using manual build..."; \
156156
fi
157157
@if [ ! -f Example2/discrete_tf.so ]; then \
158158
echo "Manual build for Example2..."; \
159159
cd Example2/discrete_tf_ert_shrlib_rtw && \
160160
gcc -fPIC -shared -o ../discrete_tf.so \
161161
-I. \
162+
-I/opt/MATLAB/R2018a/extern/include \
163+
-I/opt/MATLAB/R2018a/simulink/include \
164+
-I/opt/MATLAB/R2018a/rtw/c/src \
165+
-I/opt/MATLAB/R2018a/rtw/c/src/ext_mode/common \
166+
-I/opt/MATLAB/R2018a/rtw/c/ert \
162167
-DMODEL=discrete_tf \
163168
-DNUMST=1 \
164169
-DNCSTATES=0 \
@@ -183,7 +188,7 @@ build-example3-so:
183188
@echo "Building Example3 shared library from RTW source..."
184189
@if [ -f Example3/bouncing_ball_ert_shrlib_rtw/bouncing_ball.mk ]; then \
185190
cd Example3/bouncing_ball_ert_shrlib_rtw && \
186-
MATLAB_ROOT=/usr/local/MATLAB/R2018a make -f bouncing_ball.mk || \
191+
MATLAB_ROOT=/opt/MATLAB/R2018a make -f bouncing_ball.mk || \
187192
echo "MATLAB build failed, using manual build..."; \
188193
fi
189194
@if [ ! -f Example3/bouncing_ball.so ]; then \

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /