Repository navigation
Documentation, community files, and the 3.0.0 release workflow - #23
Merged
Merged
Conversation
rhinonix
force-pushed
the
docs/release-3.0.0
branch
from
September 16, 2026 15:19
9e08165 to
7e9dcfc
Compare
rhinonix
added this pull request to stack #24
September 16, 2026 18:15
rhinonix
force-pushed
the
docs/release-3.0.0
branch
from
September 16, 2026 18:15
7e9dcfc to
52e955c
Compare
rhinonix
force-pushed
the
docs/release-3.0.0
branch
from
September 16, 2026 18:25
52e955c to
a817518
Compare
Base automatically changed from
feat/intelligence-and-cache
to
chore/foundation
September 16, 2026 18:25
Timestamps inside JSON results now use the same UTC 'Z' form as the document envelope, and the interactive usage lines list /refresh.
- README: concise overview, installation with pipx, getting started, usage for each command and the interactive shell, output formats and exit codes, the Python API, responsible use, and troubleshooting - docs/usage.md: reference for every command, option, shell command, keyboard shortcut, and environment variable - docs/output-schema.md: JSON, JSON Lines, and CSV layouts, indicator definitions, and the stability policy for machine-readable output - docs/development.md: setup, checks, live tests, architecture, and how to record anonymized fixtures - CHANGELOG.md following Keep a Changelog, with upgrade notes for 3.0.0
- CONTRIBUTING.md covers reporting problems without exposing credentials, development setup, pull request expectations, and the contributor license agreement that keeps dual licensing possible - SECURITY.md describes private vulnerability reporting - Contributor Covenant 2.1 code of conduct - Issue forms for bugs, Equasis page changes, and feature requests, and a pull request checklist - pre-commit no longer rewrites recorded test fixtures
The zsh completion covered only the v1 commands and offered options in positions the parser rejected. Both scripts now cover every command and option, and a test fails when the parser and the scripts drift apart.
The release workflow builds once, checks that the tag matches the package version, and publishes with PyPI trusted publishing: manual runs go to TestPyPI and published GitHub releases go to PyPI after approval. RELEASING.md walks through the one-time account setup and each release.
rhinonix
force-pushed
the
docs/release-3.0.0
branch
from
September 16, 2026 18:25
a817518 to
675f548
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fifth of five pull requests toward v3.0.0. Builds on #22.
Documentation
pipx install equasis-cli, getting started, usage for each command and the interactive shell, output formats and exit codes, the Python API, responsible use, and troubleshooting. It replaces a 1,300-line README that described options and behaviour the code did not have.Community files
CONTRIBUTING.md(including the contributor license agreement that keeps dual licensing possible),SECURITY.md, and the Contributor Covenant 2.1 code of conductShell completions
zsh (
completions/_equasis) and bash (completions/equasis.bash) now cover every command and option. A test fails if the argument parser and the scripts drift apart.Release
.github/workflows/release.yml: builds once, checks the tag matches the package version, and publishes with PyPI trusted publishing (manual run publishes to TestPyPI, a published GitHub release publishes to PyPI after approval)RELEASING.md: step-by-step setup for PyPI, TestPyPI, trusted publishers, and GitHub environments, then the release checklist3.0.0Also: JSON timestamps inside results now use the same UTC
Zform as the envelope.Before publishing
RELEASING.mdEQUASIS_USERNAMEandEQUASIS_PASSWORDrepository secrets to enable the weekly live canaryVerification
ruff,ruff format --check, and strictmypypasspython -m buildandtwine check --strictpass; the wheel installed into a clean virtual environment reportsequasis 3.0.0and retrieved EVER GIVEN live with indicatorszsh -nandbash -n, and the bash script completes options and formats