docs(git-herald): Add diataxis style project documentation #7 #8

Closed

imAsparky wants to merge 0 commits from issue-7 into main

pull from: issue-7

merge into: dunwright:main

dunwright:main

dunwright:issue-60

dunwright:issue-57

Conversation 0 Commits - Files changed -

imAsparky commented 2026-04-14 08:24:26 +00:00

Owner

Copy link

closes #7

closes #7

imAsparky added the

Kind/Documentation

label 2026-04-14 08:24:26 +00:00

imAsparky added 4 commits 2026-04-14 08:24:27 +00:00

docs(git-herald): Add diataxis style project documentation #7 ... 0b0b2012d1

closes #7

chore(forgejo): Update main pr workflow #7 1df121b27a

feat(herald): Add sentinel marker support for yaml files #5 ... 1d8c8acedf

[dev-notes]:
"""
Added .yaml and .yml to SENTINELS and VERSION_FORMATS dicts.
"""

[doc-notes]:
"""
YAML files are now supported as version files.
Add the sentinel above your version string as with any other file type.
"""

closes #7

chore(docs): Add docs checks and dependencies #7 ... 31fddb648e

[dev-notes]:
"""
Added Sphinx with Furo theme and MyST parser.
Build with tox -e docs. Output in docs/_build/html.
pyproject.toml updated with sphinx, furo and myst-parser dev deps.
"""

[doc-notes]:
"""
Full documentation now available covering explanation, reference,
and how-to guides. Build locally with tox -e docs.
"""

closes #7

imAsparky self-assigned this 2026-04-14 08:24:36 +00:00

imAsparky added 1 commit 2026-04-14 09:40:23 +00:00

test(config): Fix config not recognised in CI #7 58f239c5c4

imAsparky added 1 commit 2026-04-14 09:47:48 +00:00

test(changelog): Fix permissions in CI #7 ... f8c078a404

The container runs as root which can write to read-only files regardless of chmod.
The chmod approach only works as a non-root user. We need to force the failure
by mocking write_text instead

imAsparky added 1 commit 2026-04-14 10:16:13 +00:00

docs(how-to): Update writing tests with CI gotchas #7 9b8d12f4a9

imAsparky added 1 commit 2026-04-14 10:17:56 +00:00

Merge branch 'main' into issue-7 5087c5f3a7

imAsparky closed this pull request 2026-04-14 10:23:01 +00:00

Some checks failed

Hide all checks

Test Python 3.10 Tests passed on Python 3.10

CI / Test Python 3.10 (pull_request) Successful in 53s

Details

Test Python 3.11 Tests passed on Python 3.11

CI / Test Python 3.11 (pull_request) Successful in 59s

Details

Test Python 3.12 Tests passed on Python 3.12

CI / Test Python 3.12 (pull_request) Successful in 1m1s

Details

Test Python 3.13 Tests failed on Python 3.13

CI / Test Python 3.13 (pull_request) Failing after 58s

Details

Test Python 3.14 Tests passed on Python 3.14

CI / Test Python 3.14 (pull_request) Successful in 55s

Details

CI / Lint and Type Check (pull_request) Successful in 43s

Details

CI / Update Changelog (pull_request) Has been skipped

Details

Pull request closed

This pull request cannot be reopened because the branch was deleted.

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

Compat/Breaking

Breaking change that won't be backward compatible

  

Kind/Bug

Something is not working

  

Kind/Documentation

Documentation changes

  

Kind/Enhancement

Improve existing functionality

  

Kind/Feature

New functionality

  

Kind/Security

This is security issue

  

Kind/Testing

Issue or pull request related to testing

  

Priority

Critical

The priority is critical

  

Priority

High

The priority is high

  

Priority

Low

The priority is low

  

Priority

Medium

The priority is medium

  

Reviewed

Confirmed

Issue has been confirmed

  

Reviewed

Duplicate

This issue or pull request already exists

  

Reviewed

Invalid

Invalid issue

  

Reviewed

Won't Fix

This issue won't be fixed

  

Status

Abandoned

Somebody has started to work on this but abandoned work

  

Status

Blocked

Something is blocking this issue or pull request

  

Status

Need More Info

Feedback is required to reproduce issue or to continue work

No labels

Compat/Breaking

Kind/Bug

Kind/Documentation

Kind/Enhancement

Kind/Feature

Kind/Security

Kind/Testing

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Reviewed

Confirmed

Reviewed

Duplicate

Reviewed

Invalid

Reviewed

Won't Fix

Status

Abandoned

Status

Blocked

Status

Need More Info

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

imAsparky

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

dunwright/git-herald!8

No description provided.