Flow doc fix: add description for constants, variables, text template… #1306
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: "DOC - Build and deploy with sfdx-hardis" | |
on: | |
push: | |
branches: | |
- main | |
- doc | |
jobs: | |
# Build & deploy docs | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
# Build doc with sfdx-hardis | |
- uses: actions/setup-node@v4 | |
with: | |
node-version: 20 | |
- run: yarn | |
- run: yarn prepack | |
- run: npm i @salesforce/cli -g | |
- run: echo y|sf plugins install sfdx-hardis@beta | |
- run: sf hardis:doc:plugin:generate | |
# Deploy docs with mkdocs-material | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- run: pip install mkdocs-material mdx_truly_sane_lists json-schema-for-humans mkdocs-glightbox | |
- run: mkdocs gh-deploy --force | |
git-sync: | |
runs-on: ubuntu-latest | |
needs: deploy | |
steps: | |
- name: git-sync | |
uses: wei/git-sync@v3 | |
with: | |
source_repo: "hardisgroupcom/sfdx-hardis" | |
source_branch: "gh-pages" | |
destination_repo: "git@github.com:sfdx-hardis/sfdx-hardis.github.io.git" | |
destination_branch: "gh-pages" | |
# ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} # optional | |
# source_ssh_private_key: ${{ secrets.SOURCE_SSH_PRIVATE_KEY }} # optional, will override `SSH_PRIVATE_KEY` | |
destination_ssh_private_key: ${{ secrets.SFDX_HARDIS_GITHUB_IO_SSH_PRIVATE_KEY }} # optional, will override `SSH_PRIVATE_KEY` |