polish #1309
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: Sync markdown guides to ReadMe | |
| # Run workflow for every push to the `main` branch | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'readme-sync/v0/**.md' | |
| jobs: | |
| sync-guides: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: checkout repo | |
| uses: actions/checkout@v3 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v2 | |
| with: | |
| node-version: '16' | |
| # using flowcommerce CLI rather than Readme's offical GH action for syncing b/c Readme's appears less powerful | |
| - name: clone readme-sync | |
| run: | | |
| git clone https://github.com/flowcommerce/readme-sync --branch v0.0.24 readme-cli-tool | |
| - name: install readme-sync | |
| run: | | |
| cd ./readme-cli-tool | |
| npm install | |
| - name: sync markdown guides (excludes changelog, API ref) | |
| run: | | |
| npx ts-node ./readme-cli-tool/sync/index.ts --apiKey ${{ secrets.README_API_KEY }} --version v0 --docs readme-sync/v0 |