Skip to content

Commit 836b95e

Browse files
committed
Refactoring and cleanup.
1 parent ae6e4e7 commit 836b95e

11 files changed

Lines changed: 208 additions & 295 deletions

File tree

action/README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Add this action to your workflow:
88

99
```yaml
1010
- name: Export course to SCORM
11-
uses: ./
11+
id: export
12+
uses: LiaScript/LiaScript-Exporter@master
1213
with:
1314
input-file: 'README.md'
1415
format: 'scorm1.2'
@@ -40,6 +41,7 @@ Add this action to your workflow:
4041
| `scorm-typical-duration` | Duration (PT0H5M0S format) | `PT0H5M0S` |
4142
| `scorm-iframe` | Use iframe for SCORM | `false` |
4243
| `scorm-embed` | Embed Markdown in JS | `false` |
44+
| `scorm-always-active` | Keep SCORM always active | `false` |
4345

4446
### PDF Settings
4547

@@ -119,7 +121,8 @@ jobs:
119121
- uses: actions/checkout@v4
120122
121123
- name: Export to SCORM
122-
uses: ./
124+
id: export
125+
uses: LiaScript/LiaScript-Exporter@master
123126
with:
124127
input-file: 'README.md'
125128
format: 'scorm1.2'
@@ -131,7 +134,7 @@ jobs:
131134
uses: actions/upload-artifact@v4
132135
with:
133136
name: scorm-package
134-
path: '*.zip'
137+
path: ${{ steps.export.outputs.output-file }}
135138
```
136139

137140
### Multi-Course Matrix Build
@@ -152,7 +155,8 @@ jobs:
152155
- uses: actions/checkout@v4
153156
154157
- name: Export ${{ matrix.course }} to ${{ matrix.format }}
155-
uses: ./
158+
id: export
159+
uses: LiaScript/LiaScript-Exporter@master
156160
with:
157161
input-file: '${{ matrix.course }}/README.md'
158162
format: '${{ matrix.format }}'
@@ -162,9 +166,7 @@ jobs:
162166
uses: actions/upload-artifact@v4
163167
with:
164168
name: ${{ matrix.course }}-${{ matrix.format }}
165-
path: |
166-
*.zip
167-
*.pdf
169+
path: ${{ steps.export.outputs.output-file }}
168170
```
169171

170172
### Release Automation
@@ -182,14 +184,16 @@ jobs:
182184
- uses: actions/checkout@v4
183185
184186
- name: Export to SCORM
185-
uses: ./
187+
id: export-scorm
188+
uses: LiaScript/LiaScript-Exporter@master
186189
with:
187190
input-file: 'README.md'
188191
format: 'scorm1.2'
189192
output-name: 'course-${{ github.ref_name }}'
190193
191194
- name: Export to PDF
192-
uses: ./
195+
id: export-pdf
196+
uses: LiaScript/LiaScript-Exporter@master
193197
with:
194198
input-file: 'README.md'
195199
format: 'pdf'
@@ -199,8 +203,8 @@ jobs:
199203
uses: softprops/action-gh-release@v1
200204
with:
201205
files: |
202-
*.zip
203-
*.pdf
206+
${{ steps.export-scorm.outputs.output-file }}
207+
${{ steps.export-pdf.outputs.output-file }}
204208
```
205209

206210
## Development
@@ -229,10 +233,13 @@ npm run test
229233
### Common Issues
230234

231235
**PDF export hangs or fails**
232-
- PDF exports require Chrome/Puppeteer which will require separate installation
236+
- PDF exports use Puppeteer (headless Chrome) which requires sufficient memory and may take several minutes for complex courses
237+
- Ensure the course content renders properly in a regular browser first
233238

234-
**Android APK export hangs or fails**
235-
- Android exports require the Android SDK which must be installed and configured separately
239+
**Output file not found**
240+
- Check that the `output-name` parameter matches the expected file pattern
241+
- Verify the input file path is correct relative to the repository root
242+
- Review the action logs for detailed file search information
236243

237244
### Debug Information
238245

@@ -247,7 +254,7 @@ Enable debug logging in your workflow:
247254

248255
```yaml
249256
- name: Export with debug
250-
uses: ./
257+
uses: LiaScript/LiaScript-Exporter@master
251258
with:
252259
input-file: 'README.md'
253260
format: 'scorm1.2'

action/dist/action.js

Lines changed: 16 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)