cstar-forge 0.3.0__tar.gz

cstar_forge-0.3.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+# Summary
+<!-- Feel free to remove sections irrelevant to this PR or leave the default `N/A` content -->
+
+## Breaking Changes
+<!-- List any breaking changes to interfaces, changes to inputs or outputs, or procedural changes -->
+- N/A
+
+## New Features
+<!-- List any new capabilities added -->
+- N/A
+
+## Bug Fixes
+<!-- List any behavioral changes resulting from pre-existing code performing in an unexpected manner  -->
+- N/A
+
+## Improvements
+<!-- List any improvements made to existing code or processes  -->
+- N/A
+
+## Miscellaneous
+<!-- List any non-code-related changes, such as CI, packaging, or documentation -->
+- N/A
+
+
+## Code Review Checklist
+<!-- Feel free to remove check-list items irrelevant to this PR -->
+- [ ] Closes #xxxx
+- [ ] New functionality has documentation, type hint coverage, and tests
+- [ ] Tests and `pre-commit run --all-files` are passing
+

cstar_forge-0.3.0/.github/workflows/close_jira_ticket.yaml

@@ -0,0 +1,56 @@
+name: Close Jira Ticket on Issue Close
+
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  close-jira-ticket:
+    runs-on: ubuntu-latest
+    if: contains(github.event.issue.labels.*.name, 'jira-story')
+    steps:
+      - name: Extract Jira Story Key from Issue Comment
+        id: extract_story_key
+        uses: actions/github-script@v6
+        with:
+          script: |
+            // Fetch all comments on the closed issue
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number
+            });
+            
+            // Find the comment containing the Jira link
+            const jiraComment = comments.find(comment => comment.body.includes('This issue has been linked to Jira story'));
+            if (!jiraComment) {
+              core.setFailed("No Jira comment found with story key.");
+              return;
+            }
+
+            // Extract the Jira story key from the comment
+            const match = jiraComment.body.match(/\[(.*?)\]\(https:\/\/cworthy\.atlassian\.net\/browse\/.*?\)/);
+            if (!match || match.length < 2) {
+              core.setFailed("Jira story key not found in the comment.");
+              return;
+            }
+            const storyKey = match[1];
+
+            // Print the extracted story key
+            console.log("Extracted STORY_KEY:", storyKey);
+
+            core.setOutput("story_key", storyKey);
+            
+      - name: Close Jira Ticket
+        env:
+          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN_MENDOCINO }}
+          JIRA_EMAIL: ${{ secrets.JIRA_EMAIL_MENDOCINO }}
+          STORY_KEY: ${{ steps.extract_story_key.outputs.story_key }}
+        run: |
+          story_key="${{ steps.extract_story_key.outputs.story_key }}"
+          jira_domain="https://cworthy.atlassian.net"
+
+          curl -s -w "%{http_code}" -o response.json -X POST -u "$JIRA_EMAIL:$JIRA_API_TOKEN" \
+            -H "Content-Type: application/json" \
+            --data '{"transition": {"id": "31"}}' \
+            "$jira_domain/rest/api/3/issue/$story_key/transitions"

cstar_forge-0.3.0/.github/workflows/create_jira_tickets.sh

@@ -0,0 +1,188 @@
+#!/bin/bash
+
+######################################
+# FORMAT THE TICKET SUMMARY:
+
+# Escape double quotes in ISSUE_TITLE
+ESCAPED_TITLE="${ISSUE_TITLE//\"/\\\"}"
+
+##############################
+# FORMAT THE TICKET DESCRIPTION:
+
+## Escape double quotes and newlines in ISSUE_BODY
+ESCAPED_BODY="${ISSUE_BODY//\"/\\\"}"
+
+## This is literally the only way to replace newlines with spaces that the Jira API accepts:
+IFS=' ' read -r -d '' ESCAPED_BODY <<<"$ESCAPED_BODY"
+
+## Add link back to original GitHub URL
+ESCAPED_BODY="${ESCAPED_BODY} --- [View the original GitHub issue|$GITHUB_ISSUE_URL]"
+
+##############################
+# DETERMINE ASSIGNEES
+
+# Trim and set GITHUB_ASSIGNEE_USERNAME if needed
+GITHUB_ASSIGNEE_USERNAME=$(echo "$GITHUB_ASSIGNEE_USERNAME" | xargs)
+
+
+# Get the current active sprint for our board
+RESPONSE=$(curl -s -w "%{http_code}" -o sprint_response.json -u "$JIRA_EMAIL_MENDOCINO:$JIRA_API_TOKEN_MENDOCINO" \
+  -H "Content-Type: application/json" \
+  -X GET \
+  "https://cworthy.atlassian.net/rest/agile/1.0/board/$JIRA_BOARD_ID/sprint?state=active")
+
+echo "Jira response (Code $RESPONSE):"
+cat sprint_response.json
+
+ACTIVE_SPRINT_ID=$(jq ".values.[0].id" < sprint_response.json)
+
+
+##############################
+# CREATE THE STORY
+
+# note that customfield_10020 is our sprint field
+# one could figure that out again someday by searching through the results of their GET issue fields endpoint
+
+# Create the JSON payload, adding assignee if there is one
+if [[ -n "$GITHUB_ASSIGNEE_USERNAME" ]]; then
+  # Map GitHub username to Jira account ID
+  JIRA_ASSIGNEE_ID=$(echo "$JIRA_USERID_MAP" | jq ".$GITHUB_ASSIGNEE_USERNAME" | tr -d '"')
+  cat > payload.json <<EOF
+{
+  "fields": {
+    "project": { "key": "$JIRA_BOARD_KEY" },
+    "summary": "$ESCAPED_TITLE",
+    "description": "$ESCAPED_BODY",
+    "issuetype": { "name": "Story" },
+    "assignee": { "accountId": "$JIRA_ASSIGNEE_ID" },
+    "$JIRA_SPRINT_FIELD_ID": $ACTIVE_SPRINT_ID
+  }
+}
+EOF
+else
+  cat > payload.json <<EOF
+{
+  "fields": {
+    "project": { "key": "$JIRA_BOARD_KEY" },
+    "summary": "$ESCAPED_TITLE",
+    "description": "$ESCAPED_BODY",
+    "issuetype": { "name": "Story" },
+    "$JIRA_SPRINT_FIELD_ID": $ACTIVE_SPRINT_ID
+  }
+}
+EOF
+fi
+
+# Display the JSON content for verification
+echo "Generated JSON payload:"
+cat payload.json
+
+# Make the API request to create the main story
+RESPONSE=$(curl -s -w "%{http_code}" -o response.json -X POST -u "$JIRA_EMAIL_MENDOCINO:$JIRA_API_TOKEN_MENDOCINO" \
+  -H "Content-Type: application/json" \
+  -d @payload.json \
+  "https://cworthy.atlassian.net/rest/api/2/issue")
+
+echo "Jira response (Code $RESPONSE):"
+cat response.json
+
+# Check if curl was successful
+if [[ $? -ne 0 || "$RESPONSE" -ne 201 ]]; then
+    echo "Error: Failed to make a request to Jira API."
+  exit 1
+fi
+
+##############################
+# FORMAT SUBTASKS:
+
+# Extract the ID of the story created above
+STORY_ID=$(jq -r '.key' response.json)
+
+# Verify STORY_ID is not empty
+if [[ -z "$STORY_ID" ]]; then
+  echo "Error: STORY_ID is empty. Failed to retrieve a valid story ID."
+  exit 1
+fi
+
+# Use readarray to populate TASKS array directly from matching lines in ISSUE_BODY
+readarray -t TASKS < <(echo "$ISSUE_BODY" | grep -E '^- \[[ x]\] ')
+
+# If there are tasks, create subtasks
+if [[ ${#TASKS[@]} -gt 0 ]]; then
+  echo "Creating subtasks for tasks found in the issue..."
+
+  for TASK in "${TASKS[@]}"; do
+    # Remove the `- [ ]` or `- [x]` prefix from each TASK
+    CLEANED_TASK=$(echo "$TASK" | sed 's/^- \[[ x]\] //')
+    
+    # Check for presence of colon and split based on that
+    if [[ "$CLEANED_TASK" == *:* ]]; then
+      # Split into summary and description based on the first colon
+      TASK_SUMMARY="${CLEANED_TASK%%:*}"
+      TASK_DESCRIPTION="${CLEANED_TASK#*:}"
+    else
+      # If no colon, treat the whole line as the summary and leave description empty
+      TASK_SUMMARY="$CLEANED_TASK"
+      TASK_DESCRIPTION=""
+    fi
+
+
+    ## Trim any extra whitespace or newlines in summary and description
+    TASK_SUMMARY=$(echo "$TASK_SUMMARY" | tr -d '\n' | tr -d '\r' | xargs)
+    TASK_DESCRIPTION=$(echo "$TASK_DESCRIPTION" | tr -d '\n' | tr -d '\r' | xargs)
+    
+    ## Escape double quotes in the summary and description
+    ESCAPED_TASK_SUMMARY="${TASK_SUMMARY//\"/\\\"}"
+    ESCAPED_TASK_DESCRIPTION="${TASK_DESCRIPTION//\"/\\\"}"
+    ESCAPED_TASK_SUMMARY="${ESCAPED_TASK_SUMMARY//$'\n'/ }"
+    ESCAPED_TASK_DESCRIPTION="${ESCAPED_TASK_DESCRIPTION//$'\n'/ }"
+    
+    # Create JSON payload for each subtask with summary and description
+    if [[ -n "$JIRA_ASSIGNEE_ID" ]]; then	
+	cat > subtask.json <<EOF
+{
+  "fields": {
+    "project": { "key": "$JIRA_BOARD_KEY" },
+    "summary": "$ESCAPED_TASK_SUMMARY",
+    "description": "$ESCAPED_TASK_DESCRIPTION",
+    "issuetype": { "id": "$JIRA_SUBTASK_ISSUETYPE_ID" },
+    "parent": { "key": "$STORY_ID" },
+    "assignee": { "accountId": "$JIRA_ASSIGNEE_ID" }
+  }
+}
+EOF
+    else
+	cat > subtask.json <<EOF
+{
+  "fields": {
+    "project": { "key": "$JIRA_BOARD_KEY" },
+    "summary": "$ESCAPED_TASK_SUMMARY",
+    "description": "$ESCAPED_TASK_DESCRIPTION",
+    "issuetype": { "id": "$JIRA_SUBTASK_ISSUETYPE_ID" },
+    "parent": { "key": "$STORY_ID" }
+  }
+}
+EOF
+    fi	
+    echo "Generated JSON payload for subtask:"
+    cat subtask.json
+
+    # Make the API request to create each subtask
+    SUBTASK_RESPONSE=$(curl -s -w "%{http_code}" -o subtask_response.json -X POST -u "$JIRA_EMAIL_MENDOCINO:$JIRA_API_TOKEN_MENDOCINO" \
+      -H "Content-Type: application/json" \
+      -d @subtask.json \
+      "https://cworthy.atlassian.net/rest/api/2/issue")
+
+    # Check if subtask creation was successful
+    if [[ $? -ne 0 || "$SUBTASK_RESPONSE" -ne 201 ]]; then
+      echo "Error: Failed to create subtask for '$TASK_SUMMARY'. Response:"
+      cat subtask_response.json
+      exit 1
+    else
+      echo "Subtask created successfully for '$TASK_SUMMARY'."
+      cat subtask_response.json
+    fi
+  done
+else
+  echo "No tasks found in the issue body. No subtasks created."
+fi

cstar_forge-0.3.0/.github/workflows/deploy.yaml

@@ -0,0 +1,48 @@
+# This file was created automatically with `jupyter-book init --gh-pages` 🪄 💚
+# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
+name: Jupyter Book (via myst) GitHub Pages Deploy
+on:
+  workflow_dispatch:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
+  # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
+  # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
+  BASE_URL: /${{ github.event.repository.name }}
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Install Jupyter Book (via myst)
+        run: npm install -g jupyter-book
+      - name: Build HTML Assets
+        run: jupyter-book build --html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

cstar_forge-0.3.0/.github/workflows/finalize_release_notes.yaml

@@ -0,0 +1,70 @@
+name: Finalize Release Notes
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Release tag to finalize (e.g. 0.2.0)"
+        required: true
+        type: string
+
+jobs:
+  finalize-release-notes:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Full history needed so we can switch branches and push
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Configure git identity
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Checkout or create next_release_notes branch
+        run: |
+          if git ls-remote --exit-code --heads origin next_release_notes; then
+            git checkout -b next_release_notes origin/next_release_notes
+          else
+            git checkout -b next_release_notes
+          fi
+
+      - name: Run finalize release notes script
+        run: python ci/finalize_release_notes.py "${{ inputs.tag }}"
+
+      - name: Commit and push if there are changes
+        run: |
+          git add docs/releases.md
+          if git diff --staged --quiet; then
+            echo "No release note changes — nothing to commit."
+          else
+            git commit -m "Finalize release notes for ${{ inputs.tag }}"
+            git push origin next_release_notes
+          fi
+
+      - name: Open pull request to main
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          # Note: PRs opened with the default GITHUB_TOKEN do not trigger
+          # other workflows (e.g. docs build, tests) on the PR itself.
+          if gh pr list --base main --head next_release_notes --state open --json number --jq '.[0]' | grep -q .; then
+            echo "PR from next_release_notes to main already open — skipping creation."
+          else
+            gh pr create \
+              --base main \
+              --head next_release_notes \
+              --title "Finalize release notes for ${{ inputs.tag }}" \
+              --body "Automated finalization of release notes for \`${{ inputs.tag }}\`."
+          fi

cstar_forge-0.3.0/.github/workflows/lock-artifacts.yaml

@@ -0,0 +1,50 @@
+name: Export Lock Artifacts
+
+# Renders plain conda/pip consumption artifacts (conda explicit spec +
+# pinned pypi requirements.txt, per platform) from pixi.lock via
+# scripts/export-lock-artifacts.py. Always uploaded as a workflow artifact;
+# additionally attached to the GitHub release when triggered by one, so
+# non-pixi consumers (see docs/installation.md) have something to download.
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  export:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install script dependency (pyyaml)
+        run: python -m pip install pyyaml
+
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0
+        with:
+          pixi-version: v0.76.1
+          cache: true
+
+      - name: Export lock artifacts (dev environment)
+        run: python scripts/export-lock-artifacts.py --env dev --outdir lock-artifacts
+
+      - name: Upload lock artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: lock-artifacts
+          path: lock-artifacts/
+
+      - name: Attach artifacts to release
+        if: github.event_name == 'release'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release upload "$GITHUB_REF_NAME" lock-artifacts/* --clobber

cstar_forge-0.3.0/.github/workflows/open_jira_ticket.yaml

@@ -0,0 +1,39 @@
+name: Create Jira Ticket on Label
+
+on:
+  issues:
+    types: [labeled]
+
+jobs:
+  create_jira_ticket:
+    if: contains(github.event.label.name, 'jira-story')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Run Jira Ticket Creation Script
+        env:
+          JIRA_EMAIL_MENDOCINO: ${{ secrets.JIRA_EMAIL_MENDOCINO }}
+          JIRA_API_TOKEN_MENDOCINO: ${{ secrets.JIRA_API_TOKEN_MENDOCINO }}
+          JIRA_BOARD_ID: ${{ vars.JIRA_BOARD_ID }}
+          JIRA_BOARD_KEY: ${{ vars.JIRA_BOARD_KEY }}
+          JIRA_USERID_MAP: ${{ vars.JIRA_USERID_MAP }}
+          JIRA_SPRINT_FIELD_ID: ${{ vars.JIRA_SPRINT_FIELD_ID }}
+          JIRA_SUBTASK_ISSUETYPE_ID: ${{ vars.JIRA_SUBTASK_ISSUETYPE_ID }}
+          ISSUE_TITLE: "${{ github.event.issue.title }}"
+          ISSUE_BODY: "${{ github.event.issue.body }}"
+          GITHUB_ISSUE_URL: "https://github.com/${{ github.repository }}/issues/${{ github.event.issue.number }}"
+          GITHUB_ASSIGNEE_USERNAME: "${{ github.event.issue.assignee.login }}"          
+        run: |
+          .github/workflows/create_jira_tickets.sh
+          STORY_KEY=$(jq -r '.key' response.json)
+          echo "STORY_KEY=$STORY_KEY" >> $GITHUB_ENV
+      - name: Comment on GitHub Issue
+        run: |
+          # Comment on the GitHub issue with the Jira story key
+          COMMENT_BODY="This issue has been linked to Jira story [$STORY_KEY](https://cworthy.atlassian.net/browse/$STORY_KEY)."
+          curl -X POST -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          -H "Accept: application/vnd.github.v3+json" \
+          -d "{\"body\": \"$COMMENT_BODY\"}" \
+          "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/comments"

cstar_forge-0.3.0/.github/workflows/pypipublish.yaml

@@ -0,0 +1,61 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build sdist and wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # setuptools_scm needs the full history (and tags) to derive the
+          # version from the release tag; a shallow checkout would silently
+          # fall back to fallback_version = "0.1.0" regardless of the tag.
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build
+        run: python -m pip install --upgrade build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Smoke-install the built wheel
+        run: |
+          python -m venv /tmp/smoke-env
+          /tmp/smoke-env/bin/pip install dist/*.whl
+          /tmp/smoke-env/bin/python -c "import cstar_forge"
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cstar-forge
+    permissions:
+      # Required for PyPI trusted publishing (OIDC) — no API token needed.
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1