ci: inline docs for Token and TokenBalance entities (#550) #385
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation Update | |
| on: | |
| workflow_call: | |
| push: | |
| branches: | |
| - develop | |
| jobs: | |
| update_docs: | |
| permissions: read-all | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup nodejs | |
| uses: actions/setup-node@v4 | |
| with: | |
| cache: 'yarn' | |
| node-version: 16 | |
| - name: Install dependencies | |
| run: yarn install --frozen-lockfile | |
| - name: Clean the contracts directory | |
| run: yarn clean | |
| working-directory: packages/contracts/ | |
| - name: Generate docs | |
| run: yarn run docgen | |
| working-directory: packages/contracts/ | |
| - name: Remove the plugins & token contracts docs | |
| run: rm -rf plugins token | |
| working-directory: packages/contracts/docs/developer-portal/03-reference-guide/ | |
| - name: Remove Framework Lifecycle docs | |
| run: rm -rf 04-framework-lifecycle | |
| working-directory: packages/contracts/docs/developer-portal/ | |
| - name: Format with prettier | |
| run: yarn run prettier 'packages/contracts/docs/developer-portal/03-reference-guide/**/*.md' --write | |
| - name: Checkout developer-portal | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: aragon/developer-portal | |
| ref: staging | |
| path: developer-portal | |
| token: ${{ secrets.ARABOT_PAT }} | |
| - name: Remove the docs/osx folder in the developer-portal | |
| run: rm -rf $GITHUB_WORKSPACE/developer-portal/docs/osx | |
| - name: Copy the docs/developer-portal folder to the developer-portal | |
| run: cp -R packages/contracts/docs/developer-portal $GITHUB_WORKSPACE/developer-portal/docs/osx | |
| - name: Get short commit hash | |
| id: hash | |
| run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT | |
| - name: Create Pull Request | |
| uses: peter-evans/create-pull-request@v4 | |
| with: | |
| token: ${{ secrets.ARABOT_PAT }} | |
| path: developer-portal | |
| commit-message: 'Update the Aragon OSx docs by commit ${{ steps.hash.outputs.sha_short }}' | |
| committer: 'Arabot <arabot-1@users.noreply.github.com>' | |
| branch: patch/aragon-osx-docs | |
| delete-branch: true | |
| title: Update the Aragon OSx docs | |
| body: 'Automated update by Github actions (Run: [${{ github.run_id }}](https://github.com/aragon/osx/actions/runs/${{ github.run_id }}))' | |
| reviewers: ${{ github.actor }} | |
| team-reviewers: Ara-Team-OSX |