quantflow release.instructions.md

Project instructions for releasing Quantflow, a Python project for quantitative finance and derivatives pricing. They describe how to update the version, write release notes, and publish through Git tags and automated workflows.

In plain words
What is it for?
Use them to prepare a versioned release, update its notes, create the required Git tag, and trigger publication to PyPI and GitHub.
Why use it?
They provide one agreed release process and avoid manual package publishing or release steps that the project no longer supports.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/quantmind/quantflow/release
Clone the repo
git clone --depth 1 https://github.com/quantmind/quantflow

Made for: GitHub Copilot.

Per session 667 This file is loaded in full into every session.
When invoked 667 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00667 $0.00667
Opus 5 $0.00333 $0.00333
Sonnet 5 $0.00133 $0.00133
Haiku 4.5 $0.00067 $0.00067

Measured 2d ago against content hash 138de9245ed0, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

quantflow release.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/release.instructions.md · 53 lines

How it starts

The opening of the file, as written. The whole thing — 53 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Release Instructions

Releases are driven by v* git tags. Pushing a tag triggers .github/workflows/release.yml, which runs lint and the test suite, publishes the package to PyPI (make publish), then extracts the matching ## vX.Y.Z section from docs/release-notes.md and publishes it as the GitHub Release body.

Cutting a release

  1. Bump version in pyproject.toml to the new release version.
  2. Add a ## vX.Y.Z section at the top of docs/release-notes.md with the notes for the release. The header text is matched verbatim by the workflow's awk extractor, so it must be ## vX.Y.Z exactly (no trailing dash, no title after the version). The release workflow fails if this section is missing.
  3. Commit and merge to main; let the build workflow pass.
  4. From main, run make release — it reads the version from pyproject.toml, asks for confirmation, then creates an annotated vX.Y.Z tag and pushes it. The release workflow takes it from there.

Do not publish to PyPI manually, and do not revive the old head_commit.message == 'release' flow — the tag-triggered workflow is the only supported path.

Release-notes conventions

The ## vX.Y.Z section in docs/release-notes.md is rendered both on the docs site and as the GitHub Release body, so it must follow these conventions:

  • Open with a one-paragraph summary describing the theme of the release. If the release contains breaking changes, point readers to the Breaking changes section in that paragraph.
  • Group entries under H3 subsections in this order: ### Breaking changes, ### New features, ### Improvements and fixes, ### Documentation and assets. Omit any subsection that has no entries.
  • Every PR reference must be a markdown link of the form [#NN](https://github.com/quantmind/quantflow/pull/NN) — never a bare (#NN). GitHub's auto-linking only works in some contexts, and the explicit URL works everywhere. When one entry references multiple PRs, list them comma-separated inside one set of parentheses, each as its own link.
  • Build the PR list by running git log vPREV..HEAD --oneline against the previous release tag and following each squashed-merge commit back to its PR. Cross-check with gh pr list --state merged --base main for any PRs merged since the previous tag.
  • End the section with a [Full changelog](https://github.com/quantmind/quantflow/compare/vPREV...vX.Y.Z) link comparing the new tag against the previous one.

Read the full file on GitHub · 53 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 53 lines · 667 tokens per session scan A 138de9245ed0

Subscribe to this mod's changes

quantflow release.instructions.md is an instructions file published in the GitHub repository quantmind/quantflow (52 stars, last pushed 16d ago), licensed BSD-3-Clause. It adds 667 tokens to every session, about $0.0033 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.