pytest-agent-digest 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. pytest_agent_digest-0.2.0/.changelog-config.yaml +133 -0
  2. pytest_agent_digest-0.2.0/.claude/settings.json +1 -0
  3. pytest_agent_digest-0.2.0/.claude/settings.local.json +11 -0
  4. pytest_agent_digest-0.2.0/.editorconfig +23 -0
  5. pytest_agent_digest-0.2.0/.github/ISSUE_TEMPLATE/bug_report.yaml +33 -0
  6. pytest_agent_digest-0.2.0/.github/ISSUE_TEMPLATE/feature_request.yaml +26 -0
  7. pytest_agent_digest-0.2.0/.github/changelog_templates/commit.md.jinja +9 -0
  8. pytest_agent_digest-0.2.0/.github/changelog_templates/version_heading.md.jinja +4 -0
  9. pytest_agent_digest-0.2.0/.github/dependabot.yml +17 -0
  10. pytest_agent_digest-0.2.0/.github/workflows/build-python.yaml +72 -0
  11. pytest_agent_digest-0.2.0/.github/workflows/bump-version-preview.yaml +76 -0
  12. pytest_agent_digest-0.2.0/.github/workflows/bump-version.yaml +74 -0
  13. pytest_agent_digest-0.2.0/.github/workflows/codeql-analysis.yml +72 -0
  14. pytest_agent_digest-0.2.0/.github/workflows/publish-docs-preview.yaml +50 -0
  15. pytest_agent_digest-0.2.0/.github/workflows/publish-docs.yaml +48 -0
  16. pytest_agent_digest-0.2.0/.github/workflows/release-github.yaml +43 -0
  17. pytest_agent_digest-0.2.0/.github/workflows/test.yaml +34 -0
  18. pytest_agent_digest-0.2.0/.gitignore +170 -0
  19. pytest_agent_digest-0.2.0/.pre-commit-config.yaml +64 -0
  20. pytest_agent_digest-0.2.0/CHANGELOG.md +188 -0
  21. pytest_agent_digest-0.2.0/CLAUDE.md +71 -0
  22. pytest_agent_digest-0.2.0/CODE_OF_CONDUCT.md +132 -0
  23. pytest_agent_digest-0.2.0/CONTRIBUTING.md +150 -0
  24. pytest_agent_digest-0.2.0/LICENSE +29 -0
  25. pytest_agent_digest-0.2.0/PKG-INFO +86 -0
  26. pytest_agent_digest-0.2.0/README.md +29 -0
  27. pytest_agent_digest-0.2.0/docs/assets/css/cards.css +200 -0
  28. pytest_agent_digest-0.2.0/docs/assets/css/extra.css +54 -0
  29. pytest_agent_digest-0.2.0/docs/assets/css/field-list.css +34 -0
  30. pytest_agent_digest-0.2.0/docs/assets/css/mkdocstrings.css +39 -0
  31. pytest_agent_digest-0.2.0/docs/assets/images/.gitkeep +0 -0
  32. pytest_agent_digest-0.2.0/docs/assets/images/agent-digest-logo.svg +57 -0
  33. pytest_agent_digest-0.2.0/docs/development.md +58 -0
  34. pytest_agent_digest-0.2.0/docs/index.md +17 -0
  35. pytest_agent_digest-0.2.0/docs/quickstart.md +117 -0
  36. pytest_agent_digest-0.2.0/docs/reference/api/collector.md +1 -0
  37. pytest_agent_digest-0.2.0/docs/reference/api/index.md +1 -0
  38. pytest_agent_digest-0.2.0/docs/reference/api/plugin.md +1 -0
  39. pytest_agent_digest-0.2.0/docs/reference/api/renderer.md +1 -0
  40. pytest_agent_digest-0.2.0/docs/reference/options.md +106 -0
  41. pytest_agent_digest-0.2.0/docs/specs/agent-digest-v1.md +151 -0
  42. pytest_agent_digest-0.2.0/pyproject.toml +302 -0
  43. pytest_agent_digest-0.2.0/pytest_agent_digest/__init__.py +23 -0
  44. pytest_agent_digest-0.2.0/pytest_agent_digest/collector.py +194 -0
  45. pytest_agent_digest-0.2.0/pytest_agent_digest/plugin.py +153 -0
  46. pytest_agent_digest-0.2.0/pytest_agent_digest/renderer.py +93 -0
  47. pytest_agent_digest-0.2.0/tests/__init__.py +1 -0
  48. pytest_agent_digest-0.2.0/tests/conftest.py +3 -0
  49. pytest_agent_digest-0.2.0/tests/test_benchmark.py +78 -0
  50. pytest_agent_digest-0.2.0/tests/test_collector.py +263 -0
  51. pytest_agent_digest-0.2.0/tests/test_plugin.py +119 -0
  52. pytest_agent_digest-0.2.0/tests/test_plugin_integration.py +223 -0
  53. pytest_agent_digest-0.2.0/tests/test_renderer.py +288 -0
  54. pytest_agent_digest-0.2.0/tools/benchmark_tokens.py +124 -0
  55. pytest_agent_digest-0.2.0/tools/create-release.sh +28 -0
  56. pytest_agent_digest-0.2.0/tools/gen_doc_stubs.py +29 -0
  57. pytest_agent_digest-0.2.0/uv.lock +2100 -0
  58. pytest_agent_digest-0.2.0/zensical.toml +107 -0
@@ -0,0 +1,133 @@
1
+ # For more configuration information, please see https://coordt.github.io/generate-changelog/
2
+
3
+ # User variables for reference in other parts of the configuration.
4
+ variables:
5
+ repo_url: https://github.com/callowayproject/pytest-agent-digest
6
+ changelog_filename: CHANGELOG.md
7
+
8
+ # Pipeline to find the most recent tag for incremental changelog generation.
9
+ # Leave empty to always start at first commit.
10
+ starting_tag_pipeline:
11
+ - action: ReadFile
12
+ kwargs:
13
+ filename: "{{ changelog_filename }}"
14
+ - action: FirstRegExMatch
15
+ kwargs:
16
+ pattern: (?im)^## (?P<rev>\d+\.\d+(?:\.\d+)?)\s+\(\d+-\d{2}-\d{2}\)$
17
+ named_subgroup: rev
18
+
19
+ # Used as the version title of the changes since the last valid tag.
20
+ unreleased_label: Unreleased
21
+
22
+ # Process the commit's first line for use in the changelog.
23
+ summary_pipeline:
24
+ - action: strip_spaces
25
+ - action: Strip
26
+ comment: Get rid of any periods so we don't get double periods
27
+ kwargs:
28
+ chars: .
29
+ - action: SetDefault
30
+ args:
31
+ - no commit message
32
+ - action: capitalize
33
+ - action: append_dot
34
+
35
+ # Process the commit's body for use in the changelog.
36
+ body_pipeline:
37
+ - action: ParseTrailers
38
+ comment: Parse the trailers into metadata.
39
+ kwargs:
40
+ commit_metadata: save_commit_metadata
41
+
42
+ # Process and store the full or partial changelog.
43
+ output_pipeline:
44
+ - action: IncrementalFileInsert
45
+ kwargs:
46
+ filename: "{{ changelog_filename }}"
47
+ last_heading_pattern: (?im)^## \d+\.\d+(?:\.\d+)?\s+\([0-9]+-[0-9]{2}-[0-9]{2}\)$
48
+ - action: MDFormat
49
+ kwargs:
50
+ filename: CHANGELOG.md
51
+
52
+ # Full or relative paths to look for output generation templates.
53
+ template_dirs:
54
+ - ".github/changelog_templates/"
55
+
56
+ # Group the commits within a version by these commit attributes.
57
+ group_by:
58
+ - metadata.category
59
+
60
+ # Only tags matching this regular expression are used for the changelog.
61
+ tag_pattern: ^[0-9]+\.[0-9]+(?:\.[0-9]+)?$
62
+
63
+ # Tells ``git-log`` whether to include merge commits in the log.
64
+ include_merges: false
65
+
66
+ # Ignore commits whose summary line matches any of these regular expression patterns.
67
+ ignore_patterns:
68
+ - '[@!]minor'
69
+ - '[@!]cosmetic'
70
+ - '[@!]refactor'
71
+ - '[@!]wip'
72
+ - ^$
73
+ - ^Merge branch
74
+ - ^Merge pull
75
+ - ^Version updated
76
+
77
+ # Set the commit's category metadata to the first classifier that returns ``True``.
78
+ commit_classifiers:
79
+ - action: SummaryRegexMatch
80
+ category: New
81
+ kwargs:
82
+ pattern: (?i)^(?:new|add)[^\n]*$
83
+ - action: SummaryRegexMatch
84
+ category: Updates
85
+ kwargs:
86
+ pattern: (?i)^(?:update|change|rename|remove|delete|improve|refactor|chg|modif)[^\n]*$
87
+ - action: SummaryRegexMatch
88
+ category: Fixes
89
+ kwargs:
90
+ pattern: (?i)^(?:fix)[^\n]*$
91
+ - action:
92
+ category: Other
93
+
94
+ # Tokens in git commit trailers that indicate authorship.
95
+ valid_author_tokens:
96
+ - author
97
+ - based-on-a-patch-by
98
+ - based-on-patch-by
99
+ - co-authored-by
100
+ - co-committed-by
101
+ - contributions-by
102
+ - from
103
+ - helped-by
104
+ - improved-by
105
+ - original-patch-by
106
+
107
+ # Rules applied to commits to determine the type of release to suggest.
108
+ release_hint_rules:
109
+ - match_result: dev
110
+ branch: ^((?!master|main).)*$
111
+ - match_result: patch
112
+ path: pyproject.toml
113
+ branch: master|main
114
+ - match_result: patch
115
+ grouping: Other
116
+ path: pytest_llm_report/*
117
+ branch: master|main
118
+ - match_result: patch
119
+ grouping: Fixes
120
+ path: pytest_llm_report/*
121
+ branch: master|main
122
+ - match_result: minor
123
+ grouping: Updates
124
+ path: pytest_llm_report/*
125
+ branch: master|main
126
+ - match_result: minor
127
+ grouping: New
128
+ path: pytest_llm_report/*
129
+ branch: master|main
130
+ - match_result: major
131
+ grouping: Breaking Changes
132
+ path: pytest_llm_report/*
133
+ branch: master|main
@@ -0,0 +1,11 @@
1
+ {
2
+ "permissions": {
3
+ "allow": [
4
+ "Bash(uv run:*)",
5
+ "Bash(git add:*)",
6
+ "Bash(git:*)",
7
+ "Bash(uv sync:*)",
8
+ "Bash(find:*)"
9
+ ]
10
+ }
11
+ }
@@ -0,0 +1,23 @@
1
+ # http://editorconfig.org
2
+
3
+ root = true
4
+
5
+ [*]
6
+ charset = utf-8
7
+ end_of_line = lf
8
+ insert_final_newline = true
9
+ trim_trailing_whitespace = true
10
+
11
+ [*.{py,rst,ini}]
12
+ indent_style = space
13
+ indent_size = 4
14
+
15
+ [*.{html,css,scss,json,yml}]
16
+ indent_style = space
17
+ indent_size = 2
18
+
19
+ [*.md]
20
+ trim_trailing_whitespace = true
21
+
22
+ [Makefile]
23
+ indent_style = tab
@@ -0,0 +1,33 @@
1
+ name: Bug Report
2
+ description: File a bug report.
3
+ title: "[Bug]: "
4
+ labels: ["bug"]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Thanks for taking the time to fill out this bug report!
10
+ - type: textarea
11
+ id: what-happened
12
+ attributes:
13
+ label: What happened?
14
+ description: What did you do, what happened, and what did you expect?
15
+ placeholder: Tell us what you see!
16
+ validations:
17
+ required: true
18
+ - type: input
19
+ id: version
20
+ attributes:
21
+ label: Version
22
+ description: What version of our software are you running?
23
+ validations:
24
+ required: true
25
+ - type: dropdown
26
+ id: os
27
+ attributes:
28
+ label: Operating system
29
+ description: What operating system are you using?
30
+ options:
31
+ - Linux
32
+ - MacOS
33
+ - Windows
@@ -0,0 +1,26 @@
1
+ name: Feature Request
2
+ description: Suggest an idea for this project
3
+ labels: ["enhancement"]
4
+ body:
5
+ - type: textarea
6
+ id: problem
7
+ attributes:
8
+ label: Is your feature request related to a problem? Please describe.
9
+ description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10
+ - type: textarea
11
+ id: request
12
+ attributes:
13
+ label: Describe the solution you'd like.
14
+ description: A clear and concise description of what you want to happen.
15
+ validations:
16
+ required: true
17
+ - type: textarea
18
+ id: considered-alternatives
19
+ attributes:
20
+ label: Describe alternatives you've considered
21
+ description: A clear and concise description of any alternative solutions or features you've considered.
22
+ - type: textarea
23
+ id: additional-context
24
+ attributes:
25
+ label: Additional context
26
+ description: Add any other context or screenshots about the feature request here.
@@ -0,0 +1,9 @@
1
+ - {{ commit.summary }} [{{ commit.short_sha }}]({{ repo_url }}/commit/{{ commit.sha }})
2
+ {{ commit.body|indent(2, first=True) }}
3
+ {% for key, val in commit.metadata["trailers"].items() %}
4
+ {% if key not in VALID_AUTHOR_TOKENS %}
5
+ **{{ key }}:** {{ val|join(", ") }}
6
+
7
+ {% endif %}
8
+
9
+ {% endfor %}
@@ -0,0 +1,4 @@
1
+ ## {{ version.label }} ({{ version.date_time.strftime("%Y-%m-%d") }})
2
+ {% if version.previous_tag %}
3
+ [Compare the full difference.]({{ repo_url }}/compare/{{ version.previous_tag }}...{{ version.tag }})
4
+ {% endif %}
@@ -0,0 +1,17 @@
1
+ # Keep GitHub Actions up to date with GitHub's Dependabot...
2
+ # https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
3
+ # https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
4
+ version: 2
5
+ updates:
6
+ - package-ecosystem: github-actions
7
+ directory: /
8
+ groups:
9
+ github-actions:
10
+ patterns:
11
+ - "*" # Group all Actions updates into a single larger pull request
12
+ schedule:
13
+ interval: weekly
14
+ - package-ecosystem: "pip"
15
+ directory: "/"
16
+ schedule:
17
+ interval: "weekly"
@@ -0,0 +1,72 @@
1
+ name: Build Python Package
2
+
3
+ on:
4
+ workflow_call:
5
+ inputs:
6
+ ref:
7
+ description: The branch, tag or SHA to checkout. Otherwise, uses the default branch.
8
+ required: false
9
+ type: string
10
+ default: ""
11
+ workflow_dispatch:
12
+ inputs:
13
+ ref:
14
+ description: The branch, tag or SHA to checkout. Otherwise, uses the default branch.
15
+ required: false
16
+ type: string
17
+ default: ""
18
+
19
+ jobs:
20
+ build-package:
21
+ runs-on: ubuntu-latest
22
+ permissions:
23
+ contents: read
24
+ id-token: write
25
+ attestations: write
26
+ steps:
27
+ - name: Checkout
28
+ uses: actions/checkout@v6
29
+ with:
30
+ fetch-depth: 0
31
+ ref: ${{ inputs.ref }}
32
+ - name: Package
33
+ uses: hynek/build-and-inspect-python-package@v2
34
+
35
+ call-release-github:
36
+ needs: build-package
37
+ permissions:
38
+ contents: write
39
+ packages: write
40
+ id-token: write
41
+ uses: ./.github/workflows/release-github.yaml
42
+ with:
43
+ ref: ${{ inputs.ref }}
44
+
45
+ # call-release-container:
46
+ # needs: build-package
47
+ # permissions:
48
+ # contents: write
49
+ # packages: write
50
+ # id-token: write
51
+ # uses: ./.github/workflows/release-container.yaml
52
+ # with:
53
+ # ref: ${{ inputs.ref }}
54
+
55
+
56
+ release-pypi:
57
+ needs: build-package
58
+ permissions:
59
+ contents: read
60
+ id-token: write
61
+ name: Publish released package to pypi.org
62
+ runs-on: ubuntu-latest
63
+ steps:
64
+ - name: Download packages built by build-and-inspect-python-package
65
+ uses: actions/download-artifact@v8
66
+ with:
67
+ name: Packages
68
+ path: dist
69
+
70
+ - name: Upload package to PyPI
71
+ uses: pypa/gh-action-pypi-publish@release/v1
72
+
@@ -0,0 +1,76 @@
1
+ name: Display version hint
2
+
3
+ on:
4
+ pull_request:
5
+ types: [synchronize, opened, reopened, ready_for_review]
6
+ branches: [main]
7
+
8
+ permissions:
9
+ contents: read
10
+ pull-requests: write
11
+
12
+ concurrency: version-preview-${{ github.ref }}
13
+
14
+ jobs:
15
+ preview-version:
16
+ runs-on: ubuntu-latest
17
+ steps:
18
+ - name: Checkout the repository
19
+ uses: actions/checkout@v6
20
+ with:
21
+ fetch-depth: 0
22
+
23
+ - name: Set up Python
24
+ uses: actions/setup-python@v6
25
+ with:
26
+ python-version: "3.12"
27
+
28
+ - name: Setup Git
29
+ uses: fregante/setup-git-user@v2
30
+ env:
31
+ GH_TOKEN: ${{ github.token }}
32
+
33
+ - name: Install requirements
34
+ run: |
35
+ python -m pip install bump-my-version
36
+
37
+ - name: Get the release hint
38
+ id: changelog
39
+ uses: docker://ghcr.io/callowayproject/generate-changelog:v0
40
+ with:
41
+ branch_override: ${{ github.event.pull_request.base.ref }}
42
+
43
+ - name: Get Metadata
44
+ id: get-metadata
45
+ run: |
46
+ PR_NUMBER=$(gh pr view --json number -q .number || echo "${{ github.event.number }}")
47
+ REVISION=$(git describe --tags --long | awk -F- '{print $2}')
48
+ echo "RELEASE_KIND=${{ steps.changelog.outputs.release_hint }}" >> $GITHUB_ENV
49
+ echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV
50
+ echo "REVISION=$REVISION" >> $GITHUB_ENV
51
+
52
+ - name: Bump version dry run
53
+ if: ${{ env.RELEASE_KIND != 'no-release' }}
54
+ shell: bash
55
+ run: |
56
+ # This will display a full log of what would happen if we were to bump the version.
57
+ bump-my-version bump --dry-run --verbose "$RELEASE_KIND"
58
+
59
+ # This retrieves the current and new version numbers as a JSON-formatted string.
60
+ VERSION_INFO=$(bump-my-version show --format json --increment "$RELEASE_KIND" current_version new_version)
61
+ echo "CURRENT_VERSION=$(echo $VERSION_INFO | jq -r .current_version)" >> $GITHUB_ENV
62
+ echo "NEW_VERSION=$(echo $VERSION_INFO | jq -r .new_version)" >> $GITHUB_ENV
63
+
64
+ - name: Set no-release information
65
+ if: ${{ env.RELEASE_KIND == 'no-release' }}
66
+ run: |
67
+ echo "CURRENT_VERSION=$(bump-my-version show current_version)" >> $GITHUB_ENV
68
+ echo "NEW_VERSION=$(bump-my-version show current_version)" >> $GITHUB_ENV
69
+
70
+ - name: Display the version hint
71
+ uses: s-gehring/singleton-comment@v1
72
+ with:
73
+ comment-body: |
74
+ **Version hint:** ${{ env.RELEASE_KIND }}
75
+ **Current version:** ${{ env.CURRENT_VERSION }}
76
+ **New version (when merged):** ${{ env.NEW_VERSION }}
@@ -0,0 +1,74 @@
1
+ name: Bump the version on merge
2
+ on:
3
+ pull_request:
4
+ types: [closed]
5
+ branches: [main]
6
+
7
+ jobs:
8
+ bump-version:
9
+ runs-on: ubuntu-latest
10
+ if: github.event.pull_request.merged == true
11
+ permissions:
12
+ contents: write
13
+ outputs:
14
+ build_package: ${{ steps.bump-version.outputs.build_package }}
15
+ tag_name: ${{ steps.bump-version.outputs.tag_name }}
16
+ steps:
17
+ - name: Checkout the repository
18
+ uses: actions/checkout@v6
19
+ with:
20
+ fetch-depth: 0
21
+
22
+ - name: Install uv
23
+ uses: astral-sh/setup-uv@v7
24
+ with:
25
+ enable-cache: true
26
+
27
+ - name: Set up Python
28
+ uses: actions/setup-python@v6
29
+ with:
30
+ python-version: "3.12"
31
+
32
+ - name: Setup Git
33
+ uses: fregante/setup-git-user@v2
34
+
35
+ - name: Install requirements
36
+ run: |
37
+ python -m pip install bump-my-version
38
+
39
+ - name: Generate changelog and release hint
40
+ id: changelog
41
+ uses: docker://ghcr.io/callowayproject/generate-changelog:v0
42
+
43
+ - name: Bump version
44
+ id: bump-version
45
+ shell: bash
46
+ run: |
47
+ PR_NUMBER=$(gh pr view --json number -q .number || echo "")
48
+ REVISION=$(git describe --tags --long | awk -F- '{print $2}')
49
+ RELEASE_KIND=${{ steps.changelog.outputs.release_hint }}
50
+ export PR_NUMBER REVISION RELEASE_KIND
51
+ case "$RELEASE_KIND" in
52
+ major|minor|patch)
53
+ bump-my-version bump --allow-dirty --verbose "$RELEASE_KIND"
54
+ git push
55
+ git push --tags
56
+ echo "tag_name=$(bump-my-version show current_version)" >> $GITHUB_OUTPUT
57
+ echo "build_package=true" >> $GITHUB_OUTPUT
58
+ ;;
59
+ *)
60
+ echo "build_package=false" >> $GITHUB_OUTPUT
61
+ ;;
62
+ esac
63
+
64
+ call-build-python:
65
+ needs: bump-version
66
+ if: ${{ needs.bump-version.outputs.build_package == 'true' }}
67
+ permissions:
68
+ contents: write
69
+ attestations: write
70
+ id-token: write
71
+ packages: write
72
+ uses: ./.github/workflows/build-python.yaml
73
+ with:
74
+ ref: ${{ needs.bump-version.outputs.tag_name }}
@@ -0,0 +1,72 @@
1
+ # For most projects, this workflow file will not need changing; you simply need
2
+ # to commit it to your repository.
3
+ #
4
+ # You may wish to alter this file to override the set of languages analyzed,
5
+ # or to provide custom queries or build logic.
6
+ #
7
+ # ******** NOTE ********
8
+ # We have attempted to detect the languages in your repository. Please check
9
+ # the `language` matrix defined below to confirm you have the correct set of
10
+ # supported CodeQL languages.
11
+ #
12
+ name: "CodeQL"
13
+
14
+ on:
15
+ push:
16
+ branches: [ main ]
17
+ pull_request:
18
+ # The branches below must be a subset of the branches above
19
+ branches: [ main ]
20
+ schedule:
21
+ - cron: '37 21 * * 5'
22
+
23
+ jobs:
24
+ analyze:
25
+ name: Analyze
26
+ runs-on: ubuntu-latest
27
+ permissions:
28
+ actions: read
29
+ contents: read
30
+ security-events: write
31
+
32
+ strategy:
33
+ fail-fast: false
34
+ matrix:
35
+ language: [ 'python' ]
36
+ # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
37
+ # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
38
+
39
+ steps:
40
+ - name: Checkout repository
41
+ uses: actions/checkout@v6
42
+
43
+ # Initializes the CodeQL tools for scanning.
44
+ - name: Initialize CodeQL
45
+ uses: github/codeql-action/init@v4
46
+ with:
47
+ languages: ${{ matrix.language }}
48
+ # If you wish to specify custom queries, you can do so here or in a config file.
49
+ # By default, queries listed here will override any specified in a config file.
50
+ # Prefix the list here with "+" to use these queries and those in the config file.
51
+
52
+ # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
53
+ # queries: security-extended,security-and-quality
54
+
55
+
56
+ # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
57
+ # If this step fails, then you should remove it and run the build manually (see below)
58
+ - name: Autobuild
59
+ uses: github/codeql-action/autobuild@v4
60
+
61
+ # ℹ️ Command-line programs to run using the OS shell.
62
+ # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
63
+
64
+ # If the Autobuild fails above, remove it and uncomment the following three lines.
65
+ # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
66
+
67
+ # - run: |
68
+ # echo "Run, Build Application using script"
69
+ # ./location_of_script_within_repo/buildscript.sh
70
+
71
+ - name: Perform CodeQL Analysis
72
+ uses: github/codeql-action/analyze@v4
@@ -0,0 +1,50 @@
1
+ name: Publish Preview Documentation
2
+
3
+ on:
4
+ pull_request:
5
+ types:
6
+ - opened
7
+ - reopened
8
+ - synchronize
9
+ - closed
10
+
11
+ concurrency: preview-${{ github.ref }}
12
+
13
+ jobs:
14
+ publish-preview-docs:
15
+
16
+ runs-on: ubuntu-latest
17
+ permissions:
18
+ contents: write
19
+ pull-requests: write
20
+ pages: write
21
+
22
+ steps:
23
+ - name: Checkout
24
+ uses: actions/checkout@v6
25
+ with:
26
+ fetch-depth: 0
27
+
28
+ - name: Install uv
29
+ uses: astral-sh/setup-uv@v7
30
+ with:
31
+ enable-cache: true
32
+
33
+ - name: Set up Python
34
+ uses: actions/setup-python@v6
35
+ with:
36
+ python-version: "3.12"
37
+
38
+ - name: Set up Git
39
+ uses: fregante/setup-git-user@v2
40
+
41
+ - name: Install dependencies
42
+ run: uv sync --group docs
43
+
44
+ - name: Build and publish docs
45
+ run: uv run zensical build --strict --clean
46
+
47
+ - name: Build and publish docs preview
48
+ uses: rossjrw/pr-preview-action@v1
49
+ with:
50
+ source-dir: ./site/
@@ -0,0 +1,48 @@
1
+ name: Publish Final Documentation
2
+
3
+ concurrency: docs
4
+
5
+ on:
6
+ push:
7
+ branches: [ main]
8
+
9
+ jobs:
10
+ publish-docs:
11
+
12
+ runs-on: ubuntu-latest
13
+ permissions:
14
+ contents: write
15
+ pull-requests: write
16
+ pages: write
17
+
18
+ steps:
19
+ - name: Checkout
20
+ uses: actions/checkout@v6
21
+ with:
22
+ fetch-depth: 0
23
+
24
+ - name: Install uv
25
+ uses: astral-sh/setup-uv@v7
26
+ with:
27
+ enable-cache: true
28
+
29
+ - name: Set up Python
30
+ uses: actions/setup-python@v6
31
+ with:
32
+ python-version: "3.12"
33
+
34
+ - name: Set up Git
35
+ uses: fregante/setup-git-user@v2
36
+
37
+ - name: Install dependencies
38
+ run: uv sync --group docs
39
+
40
+ - name: Build and publish docs
41
+ run: uv run zensical build --strict --clean
42
+
43
+ - uses: actions/upload-pages-artifact@v4
44
+ with:
45
+ path: site
46
+
47
+ - uses: actions/deploy-pages@v4
48
+ id: deployment