🔧 Add CITATION.cff file for academic citations

.github/workflows/build-docs.yml

@@ -30,8 +30,6 @@ jobs:
             - pyproject.toml
             - mkdocs.yml
             - mkdocs.insiders.yml
-            - .github/workflows/build-docs.yml
-            - .github/workflows/deploy-docs.yml
 
   build-docs:
     needs:
@@ -60,17 +58,17 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
         run: python -m flit install --extras doc
       - name: Install Material for MkDocs Insiders
-        if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
+        if: ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false ) && steps.cache.outputs.cache-hit != 'true'
         run: python -m pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
       - uses: actions/cache@v3
         with:
           key: mkdocs-cards-${{ github.ref }}-v1
           path: .cache
       - name: Build Docs
-        if: github.event_name == 'pull_request' && github.secret_source != 'Actions'
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == true
         run: python -m mkdocs build
       - name: Build Docs with Insiders
-        if: github.event_name != 'pull_request' || github.secret_source == 'Actions'
+        if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false
         run: python -m mkdocs build --config-file mkdocs.insiders.yml
 
 

.github/workflows/latest-changes.yml

@@ -20,7 +20,7 @@ jobs:
   latest-changes:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           # To allow latest-changes to commit to the main branch
           token: ${{ secrets.TYPER_LATEST_CHANGES }}
@@ -30,12 +30,9 @@ jobs:
         if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
         with:
           limit-access-to-actor: true
-      - uses: docker://tiangolo/latest-changes:0.2.0
-      # - uses: tiangolo/latest-changes@main
+      - uses: docker://tiangolo/latest-changes:0.0.3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           latest_changes_file: docs/release-notes.md
-          latest_changes_header: '## Latest Changes'
-          end_regex: '^## '
+          latest_changes_header: '## Latest Changes\n\n'
           debug_logs: true
-          label_header_prefix: '### '

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ default_language_version:
     python: python3.10
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.4.0
     hooks:
     -   id: check-added-large-files
     -   id: check-toml
@@ -14,7 +14,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
+    rev: v3.3.2
     hooks:
     -   id: pyupgrade
         args:
@@ -23,7 +23,7 @@ repos:
         # This file is more readable without yield from
         exclude: ^docs_src/progressbar/tutorial004\.py
 -   repo: https://github.com/PyCQA/autoflake
-    rev: v2.2.1
+    rev: v2.1.1
     hooks:
     -   id: autoflake
         args:
@@ -47,7 +47,7 @@ repos:
         name: isort (pyi)
         types: [pyi]
 -   repo: https://github.com/psf/black
-    rev: 23.10.0
+    rev: 23.3.0
     hooks:
     -   id: black
 ci:

CITATION.cff

@@ -0,0 +1,22 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Typer
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Sebastián
+    family-names: Ramírez
+    email: tiangolo@gmail.com
+identifiers:
+repository-code: 'https://github.com/tiangolo/typer'
+url: 'https://typer.tiangolo.com'
+abstract: >-
+  Typer, build great CLIs. Easy to code. Based on Python type hints.
+keywords:
+  - typer
+  - click
+license: MIT

docs/release-notes.md

@@ -1,7 +1,5 @@
 ## Latest Changes
 
-* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#606](https://github.com/tiangolo/typer/pull/606) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
-* 👷 Install MkDocs Material Insiders only when secrets are available, for Dependabot. PR [#685](https://github.com/tiangolo/typer/pull/685) by [@tiangolo](https://github.com/tiangolo).
 * ⚒️ Update build-docs.yml, do not zip docs. PR [#645](https://github.com/tiangolo/typer/pull/645) by [@tiangolo](https://github.com/tiangolo).
 * 👷 Deploy docs to Cloudflare. PR [#644](https://github.com/tiangolo/typer/pull/644) by [@tiangolo](https://github.com/tiangolo).
 * 👷 Upgrade CI for docs. PR [#642](https://github.com/tiangolo/typer/pull/642) by [@tiangolo](https://github.com/tiangolo).
@@ -11,11 +9,6 @@
 * 🐛 Fix internal type annotations and bump mypy version. PR [#638](https://github.com/tiangolo/typer/pull/638) by [@paulo-raca](https://github.com/paulo-raca).
 * 📝 Remove obsolete references to `--install-completion` for `typer.run()` scripts. PR [#595](https://github.com/tiangolo/typer/pull/595) by [@tiangolo](https://github.com/tiangolo).
 
-### Internal
-
-* 👷 Update build docs CI cache paths. PR [#707](https://github.com/tiangolo/typer/pull/707) by [@tiangolo](https://github.com/tiangolo).
-* 👷 Upgrade latest-changes GitHub Action. PR [#691](https://github.com/tiangolo/typer/pull/691) by [@tiangolo](https://github.com/tiangolo).
-
 ## 0.9.0
 
 ### Features