Skip to content

Commit 9385bb4

Browse files
committed
Merge branch 'master' into suppress
2 parents dcba2e2 + 0cd4d73 commit 9385bb4

File tree

289 files changed

+8957
-3727
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

289 files changed

+8957
-3727
lines changed

.env

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Environment variables automatically read by VS Code, e.g. running tests
2+
3+
# For tests, a large terminal width
4+
TERMINAL_WIDTH=3000

.github/DISCUSSION_TEMPLATE/questions.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ body:
3434
required: true
3535
- label: I already searched in Google "How to X in Typer" and didn't find any information.
3636
required: true
37-
- label: I already read and followed all the tutorial in the docs and didn't find an answer.
37+
- label: I already read and followed all the tutorials in the docs and didn't find an answer.
3838
required: true
3939
- label: I already checked if it is not related to Typer but to [Click](https://github.com/pallets/click).
4040
required: true
@@ -47,7 +47,7 @@ body:
4747
4848
* Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
4949
* I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
50-
* Review one Pull Request by downloading the code and following all the review process](https://typer.tiangolo.com/help-typer/#review-pull-requests).
50+
* Review one Pull Request by downloading the code and following all the [review process](https://typer.tiangolo.com/help-typer/#review-pull-requests).
5151
5252
options:
5353
- label: I commit to help with one of those options 👆

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ contact_links:
44
about: Please report security vulnerabilities to [email protected]
55
- name: Question or Problem
66
about: Ask a question or ask about a problem in GitHub Discussions.
7-
url: https://github.com/tiangolo/typer/discussions/categories/questions
7+
url: https://github.com/fastapi/typer/discussions/categories/questions
88
- name: Feature Request
99
about: To suggest an idea or ask about a feature, please start with a question saying what you would like to achieve. There might be a way to do it already.
10-
url: https://github.com/tiangolo/typer/discussions/categories/questions
10+
url: https://github.com/fastapi/typer/discussions/categories/questions
1111
- name: Show and tell
1212
about: Show what you built with Typer or to be used with Typer.
13-
url: https://github.com/tiangolo/typer/discussions/categories/show-and-tell
13+
url: https://github.com/fastapi/typer/discussions/categories/show-and-tell

.github/ISSUE_TEMPLATE/privileged.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ body:
66
value: |
77
Thanks for your interest in Typer! 🚀
88
9-
If you are not @tiangolo or he didn't ask you directly to create an issue here, please start the conversation in a [Question in GitHub Discussions](https://github.com/tiangolo/typer/discussions/categories/questions) instead.
9+
If you are not @tiangolo or he didn't ask you directly to create an issue here, please start the conversation in a [Question in GitHub Discussions](https://github.com/fastapi/typer/discussions/categories/questions) instead.
1010
- type: checkboxes
1111
id: privileged
1212
attributes:

.github/actions/comment-docs-preview-in-pr/Dockerfile

Lines changed: 0 additions & 7 deletions
This file was deleted.

.github/actions/comment-docs-preview-in-pr/action.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/actions/comment-docs-preview-in-pr/app/main.py

Lines changed: 0 additions & 68 deletions
This file was deleted.

.github/labeler.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
docs:
2+
- all:
3+
- changed-files:
4+
- any-glob-to-any-file:
5+
- docs/**
6+
- docs_src/**
7+
- all-globs-to-all-files:
8+
- '!typer/**'
9+
- '!pyproject.toml'
10+
11+
internal:
12+
- all:
13+
- changed-files:
14+
- any-glob-to-any-file:
15+
- .github/**
16+
- scripts/**
17+
- .gitignore
18+
- .pre-commit-config.yaml
19+
- pdm_build.py
20+
- requirements*.txt
21+
- all-globs-to-all-files:
22+
- '!docs/**'
23+
- '!typer/**'
24+
- '!pyproject.toml'

.github/workflows/add-to-project.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Add to Project
2+
3+
on:
4+
pull_request_target:
5+
issues:
6+
types:
7+
- opened
8+
- reopened
9+
10+
jobs:
11+
add-to-project:
12+
name: Add to project
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/[email protected]
16+
with:
17+
project-url: https://github.com/orgs/fastapi/projects/2
18+
github-token: ${{ secrets.PROJECTS_TOKEN }}

.github/workflows/build-docs.yml

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ on:
77
types:
88
- opened
99
- synchronize
10+
11+
env:
12+
UV_SYSTEM_PYTHON: 1
13+
1014
jobs:
1115
changes:
1216
runs-on: ubuntu-latest
@@ -17,8 +21,8 @@ jobs:
1721
outputs:
1822
docs: ${{ steps.filter.outputs.docs }}
1923
steps:
20-
- uses: actions/checkout@v4
21-
# For pull requests it's not necessary to checkout the code but for master it is
24+
- uses: actions/checkout@v5
25+
# For pull requests it's not necessary to checkout the code but for the main branch it is
2226
- uses: dorny/paths-filter@v3
2327
id: filter
2428
with:
@@ -28,11 +32,15 @@ jobs:
2832
- docs/**
2933
- docs_src/**
3034
- requirements-docs.txt
35+
- requirements-docs-insiders.txt
3136
- pyproject.toml
3237
- mkdocs.yml
3338
- mkdocs.insiders.yml
39+
- mkdocs.maybe-insiders.yml
40+
- mkdocs.no-insiders.yml
3441
- .github/workflows/build-docs.yml
3542
- .github/workflows/deploy-docs.yml
43+
- data/**
3644
3745
build-docs:
3846
needs:
@@ -44,40 +52,39 @@ jobs:
4452
env:
4553
GITHUB_CONTEXT: ${{ toJson(github) }}
4654
run: echo "$GITHUB_CONTEXT"
47-
- uses: actions/checkout@v4
55+
- uses: actions/checkout@v5
4856
- name: Set up Python
4957
uses: actions/setup-python@v5
5058
with:
5159
python-version: "3.11"
52-
- uses: actions/cache@v3
53-
id: cache
60+
- name: Setup uv
61+
uses: astral-sh/setup-uv@v6
5462
with:
55-
path: ${{ env.pythonLocation }}
56-
key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
63+
version: "0.4.15"
64+
enable-cache: true
65+
cache-dependency-glob: |
66+
requirements**.txt
67+
pyproject.toml
5768
- name: Install docs extras
58-
if: steps.cache.outputs.cache-hit != 'true'
59-
run: pip install -r requirements-docs.txt
69+
run: uv pip install -r requirements-docs.txt
6070
- name: Install Material for MkDocs Insiders
61-
if: ( github.event_name != 'pull_request' || github.secret_source != 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
62-
run: |
63-
pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
64-
pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
65-
pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
66-
- uses: actions/cache@v3
71+
if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
72+
run: uv pip install -r requirements-docs-insiders.txt
73+
env:
74+
TOKEN: ${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}
75+
- uses: actions/cache@v4
6776
with:
6877
key: mkdocs-cards-${{ github.ref }}-v1
6978
path: .cache
79+
- name: Verify README
80+
run: python ./scripts/docs.py verify-readme
7081
- name: Build Docs
71-
if: github.event_name == 'pull_request' && github.secret_source != 'Actions'
72-
run: python -m mkdocs build
73-
- name: Build Docs with Insiders
74-
if: ( github.event_name != 'pull_request' || github.secret_source != 'Actions' )
75-
run: python -m mkdocs build --config-file mkdocs.insiders.yml
76-
77-
- uses: actions/upload-artifact@v3
82+
run: python ./scripts/docs.py build
83+
- uses: actions/upload-artifact@v4
7884
with:
7985
name: docs-site
8086
path: ./site/**
87+
include-hidden-files: true
8188

8289
# https://github.com/marketplace/actions/alls-green#why
8390
docs-all-green: # This job does nothing and is only used for the branch protection

0 commit comments

Comments
 (0)