Add Github Action for automatic update of SDK documentation #380
Conversation
| run: npm install -g @dappnode/dappnodesdk@${{ github.event.release.tag_name }} | ||
|
|
||
| - name: Download script from sdk | ||
| run: wget https://raw.githubusercontent.com/dappnode/DAppNodeSDK/master/.github/workflows/scripts/docs.cjs -O docs.cjs |
There was a problem hiding this comment.
This action is weird, you are getting the script from upstream instead of from local
| repository: dappnode/DAppNodeDocs | ||
|
|
||
| - name: Set up dappnodesdk | ||
| run: npm install -g @dappnode/dappnodesdk@${{ github.event.release.tag_name }} |
There was a problem hiding this comment.
This is weird, you are getting the sdk from npm instead of from local, changes in branches will not make an effect in gha until merged and release if following this approach.
|
|
||
| - name: Commit to docs | ||
| run: | | ||
| git add docs/dev/sdk/commands.md |
There was a problem hiding this comment.
there are more docs to be tracked of the sdk not only commands:
- Github actions https://docs.dappnode.io/docs/dev/github-actions
- Files references https://docs.dappnode.io/docs/dev/references/docker-compose
We should first ensure that the dappnode sdk contains all this information(commands, github actions and files references), and include this information somehow in the release assets. This is an issue on its own. The release assets could be:
- commands:
.jsfiles - files references:
.jsonfiles - github actions:
.ymlfiles
| git commit -m "Updated docs for new SDK release" | ||
|
|
||
| - name: Pull request to docs | ||
| uses: peter-evans/create-pull-request@v5 |
There was a problem hiding this comment.
I dont like the idea of having a repository A making PRs on a repository B unless is strictly necessary to do so. Instead I would follow a different approach:
The dappnodeSDK should contain in its releases the necessary assets for the documentation repository to document the dappnodeSDK. The dappnode documentation could have as a dependency the dappnodeSDK, using the exports commands.js and files references (manifest-schema.json, setupWizard-schema.json) to create the sdk documentation. For the Github actions there should be used a different approach as long as they are .yml files. Consider parsing and exporting the github actions yaml files in .json format so they can be exported and used as a javascript dependency too in the dappnode documentation repo
| @@ -0,0 +1,71 @@ | |||
| const { exec } = require('child_process'); | |||
There was a problem hiding this comment.
Use esm modules instead of commonjs when possible
| @@ -0,0 +1,71 @@ | |||
| const { exec } = require('child_process'); | |||
| const fs = require('fs/promises'); | |||
There was a problem hiding this comment.
Its weird to have a scripts folder just for this purpose in the dappnode sdk
|
Wont implement |
2 participants
Added a .yml file that defines a github action for update the documentation of the sdk.
The action uses a js script to take the options of the sdk commands and create a pull request to the doc repository