copilot-session-usage 0.6.0__tar.gz → 0.6.1__tar.gz

{copilot_session_usage-0.6.0 → copilot_session_usage-0.6.1}/.github/skills/gh-release-notes/SKILL.md

@@ -1,3 +1,10 @@
+---
+name: gh-release-notes
+description: Generate end-user-friendly GitHub release notes from the actual diff between releases, including user impact, examples, breaking changes, and public documentation links.
+argument-hint: "from_tag=... to_tag=... repo_path=..."
+user-invocable: true
+---
+
 # Release Notes Generator (Git Diff Based)
 
 Generate **end-user friendly** release notes by analyzing actual code changes between releases.
@@ -186,6 +193,15 @@ Organize changes into buckets. **Only include sections that have content.** Omit
 
 ---
 
+## Non-interactive automation mode
+
+When this skill is invoked by a CI job with an explicit request for machine-readable output:
+
+- Honor the requested tag range and repository path exactly.
+- Do not modify, commit, or push repository files unless the caller explicitly requests it.
+- Return only the final release-note Markdown, without an explanation or a code fence.
+- Preserve the user-impact categories, examples, breaking-change detection, and public documentation links described above.
+
 ## How to Use This Skill in a Session
 
 **User Query:**

copilot_session_usage-0.6.1/.github/workflows/refresh-pricing.yml

@@ -0,0 +1,72 @@
+name: Refresh GitHub model pricing
+
+on:
+  schedule:
+    # Run once a day, shortly after GitHub's documentation refresh window.
+    - cron: "17 2 * * *"
+  workflow_dispatch:
+
+concurrency:
+  group: refresh-pricing
+  cancel-in-progress: false
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  refresh-pricing:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.12"
+
+      - name: Install just
+        uses: extractions/setup-just@v2
+
+      - name: Install dependencies
+        run: uv sync --frozen --all-groups
+
+      - name: Refresh pricing
+        run: just refresh-pricing
+
+      - name: Check for upstream pricing changes
+        id: changes
+        shell: bash
+        run: |
+          pricing_file="src/copilot_session_usage/data/models-and-pricing.yml"
+          if git diff --quiet -- "$pricing_file"; then
+            echo "changed=false" >> "$GITHUB_OUTPUT"
+            echo "No pricing YAML changes detected."
+          else
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+            echo "Pricing YAML changed:"
+            git diff --stat -- "$pricing_file"
+          fi
+
+      - name: Create or update pull request
+        if: steps.changes.outputs.changed == 'true'
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          base: main
+          branch: automation/refresh-pricing
+          delete-branch: true
+          commit-message: "chore(pricing): refresh GitHub model pricing"
+          title: "chore(pricing): refresh GitHub model pricing"
+          body: |
+            This automated pull request updates the bundled GitHub Copilot model pricing data.
+
+            Source: https://raw.githubusercontent.com/github/docs/main/data/tables/copilot/models-and-pricing.yml
+
+            The update was generated by running `just refresh-pricing`.
+          add-paths: |
+            src/copilot_session_usage/data/models-and-pricing.yml
+            src/copilot_session_usage/data/models-and-pricing.lock

copilot_session_usage-0.6.1/.github/workflows/release-notes.yml

@@ -0,0 +1,127 @@
+name: Generate release notes (manual)
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Existing version tag to generate a draft release for"
+        required: true
+        type: string
+
+concurrency:
+  group: release-notes-${{ github.ref }}
+  cancel-in-progress: false
+
+permissions:
+  contents: write
+
+jobs:
+  generate-release-notes:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out tagged source
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ inputs.tag || github.ref }}
+
+      - name: Resolve release range
+        id: range
+        shell: bash
+        env:
+          TARGET_TAG: ${{ inputs.tag || github.ref_name }}
+        run: |
+          set -euo pipefail
+
+          if [[ ! "$TARGET_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+([.-].*)?$ ]]; then
+            echo "::error::Expected a semantic-version tag such as v0.7.0, got '$TARGET_TAG'."
+            exit 1
+          fi
+
+          previous_tag="$(git tag --sort=-v:refname --merged "$TARGET_TAG" \
+            | awk -v current="$TARGET_TAG" '$0 != current { print; exit }')"
+
+          if [[ -z "$previous_tag" ]]; then
+            echo "::error::Could not find a previous release tag for $TARGET_TAG."
+            exit 1
+          fi
+
+          echo "target_tag=$TARGET_TAG" >> "$GITHUB_OUTPUT"
+          echo "previous_tag=$previous_tag" >> "$GITHUB_OUTPUT"
+          echo "Generating notes from $previous_tag to $TARGET_TAG."
+
+      - name: Verify release-note skill
+        env:
+          COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+
+          if [[ -z "${COPILOT_GITHUB_TOKEN:-}" ]]; then
+            echo "::error::The COPILOT_GITHUB_TOKEN repository secret is not configured."
+            echo "Create a fine-grained PAT with the Copilot Requests permission and add it as a repository secret."
+            exit 1
+          fi
+
+          if ! gh copilot -- skill list | grep -Fq 'gh-release-notes'; then
+            echo "::error::The gh-release-notes skill was not discovered by GitHub CLI."
+            exit 1
+          fi
+
+      - name: Generate release notes with the skill
+        env:
+          COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
+          PREVIOUS_TAG: ${{ steps.range.outputs.previous_tag }}
+          TARGET_TAG: ${{ steps.range.outputs.target_tag }}
+        run: |
+          set -euo pipefail
+
+          prompt="Use the /gh-release-notes skill.
+
+          Generate the final release notes for ${TARGET_TAG}, covering the actual changes from ${PREVIOUS_TAG} to ${TARGET_TAG} in ${GITHUB_WORKSPACE}.
+
+          Follow the skill's diff-based analysis process. Use the project's public documentation URL when documentation links are appropriate. Return only the final release-note Markdown, with no introduction, explanation, or code fence. Do not modify any repository files."
+
+          gh copilot -- \
+            --prompt "$prompt" \
+            --silent \
+            --no-ask-user \
+            --no-auto-update \
+            --no-color \
+            --disable-builtin-mcps \
+            --available-tools='read,shell' \
+            --allow-tool='read' \
+            --allow-tool='shell(git:*)' \
+            --allow-url='https://github.com' \
+            --allow-url='https://copilot-session-usage.readthedocs.io' \
+            > release-notes.md
+
+          if [[ ! -s release-notes.md ]]; then
+            echo "::error::The release-note skill returned an empty document."
+            exit 1
+          fi
+
+      - name: Upload generated notes for review
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-notes-${{ steps.range.outputs.target_tag }}
+          path: release-notes.md
+
+      - name: Create draft GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TARGET_TAG: ${{ steps.range.outputs.target_tag }}
+        run: |
+          set -euo pipefail
+
+          if gh release view "$TARGET_TAG" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1; then
+            echo "::error::A GitHub Release already exists for $TARGET_TAG."
+            exit 1
+          fi
+
+          gh release create "$TARGET_TAG" \
+            --repo "$GITHUB_REPOSITORY" \
+            --verify-tag \
+            --draft \
+            --title "$TARGET_TAG" \
+            --notes-file release-notes.md

copilot_session_usage-0.6.1/.github/workflows/release.yml

@@ -0,0 +1,195 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      increment:
+        description: "Version bump to apply"
+        required: true
+        type: choice
+        default: auto
+        options:
+          - auto
+          - major
+          - minor
+          - patch
+      draft:
+        description: "Create a draft release instead of publishing it"
+        required: true
+        type: boolean
+        default: false
+      force:
+        description: "Force a patch release when auto finds no eligible commit"
+        required: true
+        type: boolean
+        default: false
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ github.token }}
+      RELEASE_BRANCH: ${{ github.event.repository.default_branch }}
+      INCREMENT: ${{ inputs.increment }}
+      DRAFT_RELEASE: ${{ inputs.draft }}
+      FORCE_RELEASE: ${{ inputs.force }}
+
+    steps:
+      - name: Check out the default branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.repository.default_branch }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install release tooling
+        run: uv sync --locked --all-groups
+
+      - name: Calculate version and create tag
+        id: version
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          if [[ -n "$(git status --porcelain)" ]]; then
+            echo "::error::The release branch is not clean. Refusing to create a release."
+            git status --short
+            exit 1
+          fi
+
+          git switch --force-create "$RELEASE_BRANCH" "origin/$RELEASE_BRANCH"
+
+          previous_tag="$(git describe --tags --abbrev=0 HEAD 2>/dev/null || true)"
+          if [[ -z "$previous_tag" ]]; then
+            echo "::error::Could not find a previous release tag."
+            exit 1
+          fi
+
+          if [[ "$INCREMENT" == "auto" ]]; then
+            bump_args=(--get-next --yes)
+            if [[ "$FORCE_RELEASE" == "true" ]]; then
+              bump_args+=(--allow-no-commit)
+            fi
+            if ! next_version_output="$(uv run --no-sync cz bump "${bump_args[@]}" 2>&1)"; then
+              echo "::error::No eligible conventional commits were found for an automatic release."
+              printf '%s\n' "$next_version_output"
+              exit 1
+            fi
+          else
+            echo "Using explicit $INCREMENT bump."
+            next_version_output="$(uv run --no-sync cz bump --get-next \
+              --increment "${INCREMENT^^}" --yes --allow-no-commit)"
+          fi
+
+          next_version="$(printf '%s\n' "$next_version_output" | tail -n 1)"
+          if [[ ! "$next_version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "::error::Commitizen returned an invalid next version: '$next_version'."
+            printf '%s\n' "$next_version_output"
+            exit 1
+          fi
+
+          target_tag="v$next_version"
+          if [[ ! "$target_tag" =~ ^v[0-9]+\.[0-9]+\.[0-9]+([.-].*)?$ ]]; then
+            echo "::error::The calculated version did not create a semantic-version tag."
+            exit 1
+          fi
+          if git rev-parse "$target_tag" >/dev/null 2>&1; then
+            echo "::error::The tag $target_tag already exists."
+            exit 1
+          fi
+
+          git tag "$target_tag"
+          git push origin "$target_tag"
+
+          echo "previous_tag=$previous_tag" >> "$GITHUB_OUTPUT"
+          echo "target_tag=$target_tag" >> "$GITHUB_OUTPUT"
+          echo "Generated $target_tag from $previous_tag without modifying the default branch."
+
+      - name: Verify release-note skill
+        env:
+          COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+
+          if [[ -z "${COPILOT_GITHUB_TOKEN:-}" ]]; then
+            echo "::error::The COPILOT_GITHUB_TOKEN repository secret is not configured."
+            echo "Create a fine-grained PAT with the Copilot Requests permission and add it as a repository secret."
+            exit 1
+          fi
+
+          if ! gh copilot -- skill list | grep -Fq 'gh-release-notes'; then
+            echo "::error::The gh-release-notes skill was not discovered by GitHub CLI."
+            exit 1
+          fi
+
+      - name: Generate release notes with gh-release-notes
+        env:
+          COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
+          PREVIOUS_TAG: ${{ steps.version.outputs.previous_tag }}
+          TARGET_TAG: ${{ steps.version.outputs.target_tag }}
+        run: |
+          set -euo pipefail
+
+          prompt="Use the /gh-release-notes skill.
+
+          Generate the final release notes for ${TARGET_TAG}, covering the actual changes from ${PREVIOUS_TAG} to ${TARGET_TAG} in ${GITHUB_WORKSPACE}.
+
+          Follow the skill's diff-based analysis process. Use the project's public documentation URL when documentation links are appropriate. Return only the final release-note Markdown, with no introduction, explanation, or code fence. Do not modify, commit, or push any repository files."
+
+          gh copilot -- \
+            --prompt "$prompt" \
+            --silent \
+            --no-ask-user \
+            --no-auto-update \
+            --no-color \
+            --disable-builtin-mcps \
+            --available-tools='read,shell' \
+            --allow-tool='read' \
+            --allow-tool='shell(git:*)' \
+            --allow-url='https://github.com' \
+            --allow-url='https://copilot-session-usage.readthedocs.io' \
+            > release-notes.md
+
+          if [[ ! -s release-notes.md ]]; then
+            echo "::error::The release-note skill returned an empty document."
+            exit 1
+          fi
+
+      - name: Upload generated notes
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-notes-${{ steps.version.outputs.target_tag }}
+          path: release-notes.md
+
+      - name: Create GitHub release
+        env:
+          TARGET_TAG: ${{ steps.version.outputs.target_tag }}
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          if gh release view "$TARGET_TAG" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1; then
+            echo "::error::A GitHub Release already exists for $TARGET_TAG."
+            exit 1
+          fi
+
+          release_args=(
+            --repo "$GITHUB_REPOSITORY"
+            --verify-tag
+            --title "$TARGET_TAG"
+            --notes-file release-notes.md
+          )
+          if [[ "$DRAFT_RELEASE" == "true" ]]; then
+            release_args+=(--draft)
+          fi
+
+          gh release create "$TARGET_TAG" "${release_args[@]}"

copilot_session_usage-0.6.1/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to copilot-session-usage
+
+## Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/gsemet/copilot-session-usage
+cd copilot-session-usage
+
+# Install dependencies (uses uv)
+just dev
+```
+
+## Development workflow
+
+```bash
+# Run tests
+just test
+
+# Run full validation
+just preflight
+
+# Build documentation
+just docs
+
+# Serve docs with auto-reload
+just docs-serve
+```
+
+## Code style
+
+- **Formatter**: ruff (line length 100)
+- **Linter**: ruff, ty, mypy
+- **Type checker**: mypy (strict)
+- **Test runner**: pytest with pytest-cov
+
+## Adding features
+
+1. Add or update code in `src/copilot_session_usage/`
+2. Add tests in `tests/`
+3. Update documentation in `docs/source/`
+4. Run `just preflight` to validate
+5. Submit a pull request
+
+## Release process
+
+1. Open the **Release** workflow under the repository's Actions tab.
+2. Run it from the default branch, choosing `auto` to derive the major, minor, or
+	patch bump from conventional commits, or choose an explicit bump. Enable
+	`force` to create a patch release when `auto` finds no eligible commit.
+3. The workflow uses Commitizen to calculate the next version, creates and pushes
+	the `vX.Y.Z` tag on the existing default-branch commit, and invokes the
+	`gh-release-notes` skill through `gh copilot`. It does not create a
+	version/changelog commit.
+4. The generated notes are uploaded as an artifact and used to create the GitHub
+	Release. Enable the `draft` option if the release needs review before publishing.
+5. Publishing the GitHub Release triggers CI and publishes the package to PyPI via
+	OIDC.
+
+The workflow requires a repository secret named `COPILOT_GITHUB_TOKEN`. It must be
+a fine-grained token with the **Copilot Requests** permission. The normal Actions
+`GITHUB_TOKEN` is used for repository writes and GitHub Release creation.
+
+The **Generate release notes (manual)** workflow remains available when notes need
+to be regenerated for an existing tag without creating a new release.

{copilot_session_usage-0.6.0 → copilot_session_usage-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: copilot-session-usage
-Version: 0.6.0
+Version: 0.6.1
 Summary: Usage and cost analytics for GitHub Copilot and Copilot-CLI session logs
 Project-URL: Homepage, https://github.com/gsemet/copilot-session-usage
 Project-URL: Documentation, https://copilot-session-usage.readthedocs.io/en/stable/