Skip to content

Packaged datasheet renderer integration #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 26 commits into from
Nov 23, 2022
Merged

Packaged datasheet renderer integration #619

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
346743f
Use packaged renderer
sebromero Jul 8, 2022
2afd067
Rename directory
sebromero Jul 8, 2022
7d1af95
Use renamed env var
sebromero Jul 8, 2022
3e16b25
Change organization name in package
sebromero Jul 8, 2022
5b5a68e
Update import
sebromero Jul 8, 2022
22b5919
Use binary command instead of client js
sebromero Jul 8, 2022
e040f33
Add stylesheet path config
sebromero Oct 20, 2022
c60da88
Remove slashes from exclude patterns to work on Win
sebromero Oct 25, 2022
9bc46e2
Update dependency
sebromero Oct 28, 2022
409e864
Adjust CI command
sebromero Oct 28, 2022
e563e57
Add Github registry to config
sebromero Oct 28, 2022
0dafc76
Revert "Add Github registry to config"
sebromero Oct 28, 2022
ee57233
Remove spaces from the scripts
marqdevx Nov 2, 2022
617a23e
Install fonts on windows
marqdevx Nov 2, 2022
8d80460
Fix and update npm package info
marqdevx Nov 22, 2022
19fe5b7
Merge pull request #680 from arduino/marqdevx/datasheet-renderer/npm-…
sebromero Nov 22, 2022
0932128
Render datasheets as separate step
sebromero Nov 22, 2022
5f9df96
Update path in action step
sebromero Nov 22, 2022
14ebc8e
Use env variable for workspace path
sebromero Nov 22, 2022
7f615de
Use bracket formatting of env variable
sebromero Nov 22, 2022
4e8c705
Improve datasheet rendering script
sebromero Nov 22, 2022
9cd7c7b
Check for empty variable
sebromero Nov 22, 2022
342a62b
Update dependencies
sebromero Nov 22, 2022
ec79021
Update docs dependency
sebromero Nov 22, 2022
2304462
Add datasheet rendering step to production build
sebromero Nov 22, 2022
7a2f3ab
Merge branch 'main' into sebromero/datasheet-renderer-integration
sebromero Nov 22, 2022
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: 1 addition & 1 deletion .github/workflows/deploy-prd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:

- run: npm install

- run: GENERATE_DATASHEETS=true npm run build
- run: RENDER_DATASHEETS=true npm run build

- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-stg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:

- run: npm install

- run: GENERATE_DATASHEETS=true npm run build
- run: RENDER_DATASHEETS=true npm run build

- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
Expand Down
16 changes: 8 additions & 8 deletions .vscode/tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,14 @@
"problemMatcher": []
},
{
"label": "Generate all datasheets",
"label": "Render all datasheets",
"type": "shell",
"command": "./generate-datasheets.sh",
"command": "./render-datasheets.sh",
"options": {
"cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-generator"
"cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-rendering"
},
"windows": {
"command": ".\\generate-datasheets.cmd"
"command": ".\\render-datasheets.cmd"
},
"group": "none",
"presentation": {
Expand All @@ -114,14 +114,14 @@
"problemMatcher": []
},
{
"label": "Generate datasheet (current document)",
"label": "Render datasheet (current document)",
"type": "shell",
"command": "./generate-datasheets.sh '../../${relativeFileDirname}'",
"command": "./render-datasheets.sh '../../${relativeFileDirname}'",
"options": {
"cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-generator"
"cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-rendering"
},
"windows": {
"command": ".\\generate-datasheets.cmd '..\\..\\${relativeFileDirname}'"
"command": ".\\render-datasheets.cmd '..\\..\\${relativeFileDirname}'"
},
"group": "none",
"presentation": {
Expand Down
12 changes: 12 additions & 0 deletions scripts/datasheet-rendering/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"datasheetFile" : "datasheet.md",
"excludePatterns" : [".git", "template", "_unlisted"],
"defaultSourcePath" : "../../content/hardware",
"relativeBuildPath" : "../downloads",
"datasheetsFolder" : "datasheets",
"styleSheetsPath" : "./styles",
"previousDocumentationFolder" : "previous-documentation",
"subtitle" : "Product Reference Manual",
"datasheetSuffix": "-datasheet.pdf",
"identifierPrefix": "SKU"
}
Loading