FilesExpand file tree

v2.3.0

/

deploy-docs.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

73 lines (62 loc) · 2.27 KB

v2.3.0

/

deploy-docs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

73 lines (62 loc) · 2.27 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

name: Deploy Docs

on:

push:

branches:

# main is the sole deployer of the combined site (v2 at / and /v2/, v1.x

# at /v1/); the v1.x branch has no deploy workflow. A v1.x docs change is

# published by the next main deploy or a manual workflow_dispatch here.

- main

paths:

- docs/**

# docs pages include their code blocks from these files via `--8<--`, so a

# change here changes the rendered site even when no .md file moves.

- docs_src/**

# translated pages and the language registry feed the site/<code>/ sites

- i18n/**

- mkdocs.yml

- src/mcp/**

- src/mcp-types/**

- scripts/build-docs.sh

- scripts/docs/**

- pyproject.toml

- uv.lock

- .github/workflows/deploy-docs.yml

workflow_dispatch:

concurrency:

group: deploy-docs

# Newest run wins. build-docs.sh builds the tips of main and v1.x, not the

# triggering commit, so a newer run publishes everything an older one would,

# and Pages takes the site as one artifact, so a cancelled run leaves the live

# site as it was. With `false`, a run that never gets a runner holds the group

# and every later deploy waits behind it.

cancel-in-progress: true

jobs:

deploy-docs:

runs-on: ubuntu-latest

permissions:

contents: read

pages: write

id-token: write

environment:

name: github-pages

url: ${{ steps.deployment.outputs.page_url }}

steps:

- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

persist-credentials: false

- name: Install uv

uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0

with:

enable-cache: true

version: 0.9.5

- name: Build combined docs (main at / and /v2/, v1.x at /v1/)

run: bash scripts/build-docs.sh site

- name: Configure Pages

uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

- name: Upload Pages artifact

uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0

with:

path: site

- name: Deploy to GitHub Pages

id: deployment

uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1