docs: revise developer guide documentation BM-1081 (#3368) #9423
Workflow file for this run
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: Build | |
| on: [push] | |
| jobs: | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [macos-latest, windows-latest] | |
| env: | |
| NODE_OPTIONS: "--max-old-space-size=8192" | |
| steps: | |
| - uses: linz/action-typescript@v3 | |
| build-deploy: | |
| runs-on: ubuntu-latest | |
| concurrency: deploy-${{ github.ref }} | |
| permissions: | |
| id-token: write | |
| contents: write | |
| steps: | |
| - uses: linz/action-typescript@v3 | |
| - name: Bundle | |
| run: | | |
| npx lerna run bundle --stream | |
| # TODO: running a giant copy command to import CSS and SVG files into the docs file in not super ideal | |
| - name: Build docs | |
| run: | | |
| cp node_modules/@linzjs/lui/dist/assets/images/linz-motif.svg docs/ | |
| docker run --rm -v ${PWD}:/docs ghcr.io/linz/basemaps-mkdocs:v1 build | |
| - name: Store docs artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: packages/landing/dist/docs | |
| # pulls all tags (needed for lerna to correctly version) | |
| - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* # see https://stackoverflow.com/a/60184319/9285308 | |
| - name: Check Dependencies | |
| run: node scripts/detect.unlinked.dep.mjs | |
| - name: (Prod) Create tag | |
| if: github.ref == 'refs/heads/master' && startsWith(github.event.head_commit.message, 'release:') | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| CURRENT_VERSION=$(node -p "require('./lerna.json').version") | |
| git tag v${CURRENT_VERSION} -m v${CURRENT_VERSION} | |
| git push --tags | |
| - name: (Prod) Create github release | |
| if: github.ref == 'refs/heads/master' && startsWith(github.event.head_commit.message, 'release:') | |
| run: npx conventional-github-releaser -p angular | |
| env: | |
| CONVENTIONAL_GITHUB_RELEASER_TOKEN: ${{secrets.GITHUB_TOKEN}} | |
| - name: (Prod) Publish NPM | |
| if: github.ref == 'refs/heads/master' && startsWith(github.event.head_commit.message, 'release:') | |
| run: npx lerna publish from-git --yes | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN_LINZJS}} | |
| - name: Benchmark | |
| uses: blacha/hyperfine-action@v1 | |
| deploy-dev: | |
| runs-on: ubuntu-latest | |
| concurrency: deploy-dev-${{ github.ref }} | |
| needs: [build-deploy] | |
| if: github.ref == 'refs/heads/master' && github.repository == 'linz/basemaps' | |
| environment: | |
| name: nonprod | |
| url: https://dev.basemaps.linz.govt.nz | |
| permissions: | |
| id-token: write | |
| contents: write | |
| steps: | |
| - uses: linz/action-typescript@v3 | |
| - name: Build docs | |
| run: | | |
| # dist folder must exist or it will be owned by root | |
| mkdir -p packages/landing/dist | |
| cp node_modules/@linzjs/lui/dist/assets/images/linz-motif.svg docs/ | |
| docker run \ | |
| --rm \ | |
| -v ${PWD}:/docs \ | |
| -e GOOGLE_ANALYTICS \ | |
| -e BASEMAPS_DOCS_URL \ | |
| ghcr.io/linz/basemaps-mkdocs:v1 build | |
| env: | |
| GOOGLE_ANALYTICS: ${{ secrets.GOOGLE_ANALYTICS }} | |
| BASEMAPS_DOCS_URL: https://dev.basemaps.linz.govt.nz/docs/ | |
| # pulls all tags (needed for lerna to correctly version) | |
| - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* # see https://stackoverflow.com/a/60184319/9285308 | |
| - name: (Dev) Configure AWS Credentials | |
| uses: aws-actions/configure-aws-credentials@v4.0.2 | |
| with: | |
| aws-region: ap-southeast-2 | |
| mask-aws-account-id: true | |
| role-to-assume: ${{ secrets.AWS_ROLE_ARN }} | |
| - name: (Dev) Deploy | |
| run: | | |
| npx lerna run bundle --stream | |
| npx lerna run deploy:deploy --stream | |
| env: | |
| GOOGLE_ANALYTICS: ${{ secrets.GOOGLE_ANALYTICS }} | |
| NODE_ENV: 'dev' | |
| - name: (Dev) After Deploy Smoke Test | |
| run: | | |
| cd packages/smoke | |
| node --test | |
| deploy-prod: | |
| runs-on: ubuntu-latest | |
| concurrency: deploy-prod-${{ github.ref }} | |
| needs: [deploy-dev] | |
| if: github.ref == 'refs/heads/master' && startsWith(github.event.head_commit.message, 'release:') | |
| environment: | |
| name: prod | |
| url: https://basemaps.linz.govt.nz | |
| permissions: | |
| id-token: write | |
| contents: write | |
| steps: | |
| - uses: linz/action-typescript@v3 | |
| - name: Build docs | |
| run: | | |
| # dist folder must exist or it will be owned by root | |
| mkdir -p packages/landing/dist | |
| cp node_modules/@linzjs/lui/dist/assets/images/linz-motif.svg docs/ | |
| docker run \ | |
| --rm \ | |
| -v ${PWD}:/docs \ | |
| -e GOOGLE_ANALYTICS \ | |
| -e BASEMAPS_DOCS_URL \ | |
| ghcr.io/linz/basemaps-mkdocs:v1 build | |
| env: | |
| GOOGLE_ANALYTICS: ${{ secrets.GOOGLE_ANALYTICS }} | |
| BASEMAPS_DOCS_URL: https://basemaps.linz.govt.nz/docs/ | |
| # pulls all tags (needed for lerna to correctly version) | |
| - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* # see https://stackoverflow.com/a/60184319/9285308 | |
| - name: (Prod) Configure AWS Credentials | |
| uses: aws-actions/configure-aws-credentials@v4.0.2 | |
| with: | |
| aws-region: ap-southeast-2 | |
| mask-aws-account-id: true | |
| role-to-assume: ${{ secrets.AWS_ROLE_ARN }} | |
| - name: (Prod) Deploy | |
| run: | | |
| npx lerna run bundle --stream | |
| npx lerna run deploy:deploy --stream | |
| env: | |
| NODE_ENV: 'production' | |
| GOOGLE_ANALYTICS: ${{ secrets.GOOGLE_ANALYTICS }} | |
| - name: (Prod) After Deploy Smoke Test | |
| run: | | |
| cd packages/smoke | |
| BASEMAPS_HOST=https://basemaps.linz.govt.nz node --test |