Skip to content

api: GeoIP

api: GeoIP #14846

Workflow file for this run

name: Hugo Docs
on:
push:
branches:
- "main"
paths:
- 'site/**'
- 'tools/make/docs.mk'
pull_request:
branches:
- "main"
paths:
- 'site/**'
- 'tools/make/docs.mk'
permissions:
contents: read
jobs:
docs-lint:
runs-on: ubuntu-22.04
steps:
- name: Check out code
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
with:
ref: ${{ github.event.pull_request.head.sha }}
- uses: ./tools/github-actions/setup-deps
- name: Install markdownlint-cli
run: npm install -g markdownlint-cli@v0.47.0
- name: Run markdown linter
run: make lint.markdown
- name: Install linkinator
run: npm install -g linkinator@7.4.0
- name: Check links
run: make docs docs-check-links
docs-build:
runs-on: ubuntu-latest
needs: docs-lint
permissions:
contents: write
steps:
- name: Git checkout
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
with:
submodules: true
ref: ${{ github.event.pull_request.head.sha }}
- uses: ./tools/github-actions/setup-deps
- name: Setup Hugo
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0
with:
hugo-version: 'latest'
extended: true
- name: Setup Node
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
with:
node-version: '18'
- name: Install Site Dependencies and Build Site
run: make docs
# Upload docs for GitHub Pages
- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
with:
# Path of the directory containing the static assets.
path: site/public
# Duration after which artifact will expire in days.
# retention-days: # optional, default is 1
# This workflow contains a single job called "build"
docs-publish:
if: github.event_name == 'push'
runs-on: ubuntu-latest
needs: docs-build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
deployments: write
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5