github-docs/pyproject.toml at main · PureStorage-OpenConnect/github-docs · GitHub

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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
[tool.git-cliff.changelog]
header = """
# Changelog\n
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
"""
body = """
{% if version %}\
    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
    ## [Unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | upper_first }}
    {% for commit in commits %}
        - {{ commit.message | upper_first }}\
    {% endfor %}
{% endfor %}\n
"""
footer = """
<!-- generated by git-cliff -->
"""

[tool.git-cliff.git]
conventional_commits = true
commit_parsers = [
    { message = "(?i)^.*: (add|support)", group = "Added" },
    { message = "(?i)^.*: (remove|delete)", group = "Removed" },
    { message = "^(fix|test)|^.*: fix", group = "Fixed" },
    { message = "^.*", group = "Changed" },
]
tag_pattern = "v[0-9]*"
skip_tags = "v0.1.0-beta.1"
sort_commits = "oldest"

[project]
name = "github-docs"
version = "0.1.0"
description = "Automatically generate documentation for GitHub Actions."
authors = [
    { name = "Radek Sprta", email = "rsprta@purestorage.com" },
]
license = "Apache-2.0"
license-files = ["LICENSE"]
requires-python = ">=3.11"
dependencies = [
    "ruamel.yaml>=0.19.0",
    "typer>=0.24.0",
    "httpx>=0.28.1,<0.29",
    "jinja2>=3.1.6",
    "jsonschema>=4.17.3",
]

[project.scripts]
github-docs = "github_docs.__main__:cli"

[dependency-groups]
dev = [
    "mypy>=2.3.1",
    "pytest>=9.0.0",
    "pytest-cov>=7.1.0",
    "pytest-vcr>=1.0.2",
    "types-jsonschema>=4.26.0.20261006",
]

[tool.uv]
package = true

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build.targets.wheel]
packages = ["src/github_docs"]

[tool.pytest.ini_options]
# As ini options, not addopts: --strict-* via addopts never reach the ini store.
strict_markers = true
strict_config = true
markers = [
    "vcr: replay HTTP interactions from a recorded cassette",
]
testpaths = ["tests"]

[tool.coverage.run]
branch = true
source = ["src/github_docs"]

[tool.coverage.report]
exclude_also = ["raise NotImplementedError"]
show_missing = true
fail_under = 96

[tool.mypy]
strict = true
files = ["src/github_docs"]

[tool.ruff]
target-version = "py311"

[tool.ruff.lint]
select = ["E", "F", "I", "UP", "B", "N", "SIM", "RUF"]