easydiffraction 0.16.0__tar.gz → 0.18.0__tar.gz

easydiffraction-0.18.0/.codecov.yml

@@ -0,0 +1,31 @@
+# Codecov configuration
+# https://docs.codecov.com/docs/codecov-yaml
+
+github_checks:
+  annotations: true
+
+ignore:
+  - 'src/easydiffraction/report/templates/html/vendor/**'
+  - 'src/easydiffraction/report/templates/tex/styles/**'
+  - 'src/easydiffraction/utils/_vendored/jupyter_dark_detect/**'
+
+comment:
+  layout: 'reach, diff, flags, files'
+  behavior: default
+  require_changes: false
+  require_base: false
+  require_head: true
+
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+        # Make project coverage informational (won't block PR)
+        informational: true
+    patch:
+      default:
+        target: auto
+        # Require patch coverage but with threshold
+        threshold: 1%

easydiffraction-0.18.0/.codefactorignore

@@ -0,0 +1,15 @@
+# CodeFactor exclude patterns configuration must be done online:
+# https://www.codefactor.io/repository/github/easyscience/diffraction-lib/ignore
+#
+# Last updated: 2026-05-29
+#
+# Exclude patterns:
+# deps/**
+# docs/**
+# src/easydiffraction/report/templates/html/vendor/**
+# src/easydiffraction/report/templates/tex/styles/**
+# src/easydiffraction/utils/_vendored/jupyter_dark_detect/**
+# tests/**
+# tmp/**
+# tools/**
+# tutorials/**

easydiffraction-0.18.0/.copier-answers.yml

@@ -0,0 +1,26 @@
+# WARNING: Do not edit this file manually.
+# Any changes will be overwritten by Copier.
+_commit: v0.12.0
+_src_path: gh:easyscience/templates
+app_docs_url: https://easyscience.github.io/diffraction-app
+app_doi: 10.5281/zenodo.18163581
+app_package_name: easydiffraction_app
+app_python: '3.14'
+app_repo_name: diffraction-app
+home_page_url: https://easyscience.github.io/diffraction
+home_repo_name: diffraction
+lib_docs_url: https://easyscience.github.io/diffraction-lib
+lib_doi: 10.5281/zenodo.18163581
+lib_package_name: easydiffraction
+lib_python_max: '3.14'
+lib_python_min: '3.12'
+lib_repo_name: diffraction-lib
+project_contact_email: support@easydiffraction.org
+project_copyright_years: 2021-2026
+project_extended_description: A software for calculating diffraction patterns based
+    on a structural model and refining its parameters against experimental data
+project_name: EasyDiffraction
+project_short_description: Diffraction data analysis
+project_shortcut: ED
+project_type: both
+template_type: lib

easydiffraction-0.18.0/.github/actions/setup-pixi/action.yml

@@ -0,0 +1,44 @@
+name: 'Setup Pixi Environment'
+description: 'Wrapper for prefix-dev/setup-pixi'
+inputs:
+  environments:
+    description: 'Pixi environments to setup'
+    required: false
+    default: 'default'
+  activate-environment:
+    description: 'Environment to activate'
+    required: false
+    default: 'default'
+  run-install:
+    description: 'Whether to run pixi install'
+    required: false
+    default: 'true'
+  locked:
+    description: 'Whether to run pixi install --locked'
+    required: false
+    default: 'false'
+  frozen:
+    description: 'Whether to run pixi install --frozen'
+    required: false
+    default: 'true'
+  cache:
+    description: 'Whether to use cache'
+    required: false
+    default: 'false'
+  post-cleanup:
+    description: 'Whether to run post cleanup'
+    required: false
+    default: 'false'
+
+runs:
+  using: 'composite'
+  steps:
+    - uses: prefix-dev/setup-pixi@v0.9.5
+      with:
+        environments: ${{ inputs.environments }}
+        activate-environment: ${{ inputs.activate-environment }}
+        run-install: ${{ inputs.run-install }}
+        locked: ${{ inputs.locked }}
+        frozen: ${{ inputs.frozen }}
+        cache: ${{ inputs.cache }}
+        post-cleanup: ${{ inputs.post-cleanup }}

easydiffraction-0.18.0/.github/workflows/coverage.yml

@@ -0,0 +1,70 @@
+name: Coverage checks
+
+on:
+  # Trigger the workflow on push to develop
+  push:
+    branches:
+      - develop
+  # Trigger the workflow on pull request
+  pull_request:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Need permissions to trigger the dashboard build workflow
+permissions:
+  actions: write
+  contents: read
+
+# Allow only one concurrent workflow per PR or branch ref.
+# Cancel in-progress runs only for pull requests, but let branch push runs finish.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+# Set the environment variables to be used in all jobs defined in this workflow
+env:
+  CI_BRANCH: ${{ github.head_ref || github.ref_name }}
+
+jobs:
+  # Job 1: Run docstring coverage
+  docstring-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v6
+
+      - name: Set up pixi
+        uses: ./.github/actions/setup-pixi
+
+      - name: Run docstring coverage
+        run: pixi run docstring-coverage
+
+  # Job 2: Run unit tests with coverage and upload to Codecov
+  unit-tests-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v6
+
+      - name: Set up pixi
+        uses: ./.github/actions/setup-pixi
+
+      - name: Run unit tests with coverage
+        run: pixi run unit-tests-coverage --cov-report=xml:coverage-unit.xml
+
+      - name: Upload unit tests coverage to Codecov
+        if: ${{ !cancelled() }}
+        uses: ./.github/actions/upload-codecov
+        with:
+          name: unit-tests-job
+          flags: unittests
+          files: ./coverage-unit.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  # Job 4: Build and publish dashboard (reusable workflow)
+  run-reusable-workflows:
+    needs: [docstring-coverage, unit-tests-coverage] # depend on the previous jobs
+    uses: ./.github/workflows/dashboard.yml
+    secrets: inherit

easydiffraction-0.18.0/.github/workflows/dashboard.yml

@@ -0,0 +1,115 @@
+name: Dashboard build and publish
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: dashboard-publish-${{ github.repository }}
+  cancel-in-progress: false
+
+# Set the environment variables to be used in all jobs defined in this workflow
+env:
+  CI_BRANCH: ${{ github.head_ref || github.ref_name }}
+  DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+  DEVELOP_BRANCH: develop
+  REPO_OWNER: ${{ github.repository_owner }}
+  REPO_NAME: ${{ github.event.repository.name }}
+
+jobs:
+  dashboard:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up pixi
+        uses: ./.github/actions/setup-pixi
+
+      # Install badgery into the active Pixi environment without modifying
+      # pixi.toml/pixi.lock. Using `pixi add` here re-solves the whole project
+      # and rebuilds the local editable package, which can cause intermittent
+      # Linux CI failures (`Text file busy`, os error 26).
+      - name: Install badgery
+        shell: bash
+        run: pixi run python -m pip install git+https://github.com/enhantica/badgery
+
+      - name: Run docstring coverage and code complexity/maintainability checks
+        run: |
+          for BRANCH in $DEFAULT_BRANCH $DEVELOP_BRANCH $CI_BRANCH; do
+            echo
+            echo "🔹🔸🔹🔸🔹 Processing branch $BRANCH 🔹🔸🔹🔸🔹"
+            if [ -d "../$BRANCH" ]; then
+              echo "Branch $BRANCH already processed, skipping"
+              continue
+            fi
+
+            git worktree add ../$BRANCH origin/$BRANCH
+            mkdir -p reports/$BRANCH
+
+            echo "Docstring coverage for branch $BRANCH"
+            pixi run interrogate -c pyproject.toml --fail-under=0 ../$BRANCH/src > reports/$BRANCH/coverage-docstring.txt
+
+            echo "Cyclomatic complexity for branch $BRANCH"
+            pixi run radon cc -s -j ../$BRANCH/src > reports/$BRANCH/cyclomatic-complexity.json
+
+            echo "Maintainability index for branch $BRANCH"
+            pixi run radon mi -j ../$BRANCH/src > reports/$BRANCH/maintainability-index.json
+
+            echo "Raw metrics for branch $BRANCH"
+            pixi run radon raw -s -j ../$BRANCH/src > reports/$BRANCH/raw-metrics.json
+          done
+
+      - name: Generate dashboard HTML
+        run: >
+          pixi run python -m badgery --config .badgery.yaml --repo ${{ github.repository
+          }} --branch ${{ env.CI_BRANCH }} --output index.html
+
+      - name: Prepare publish directory
+        run: |
+          mkdir -p _dashboard_publish/${{ env.REPO_NAME }}/${{ env.CI_BRANCH }}
+          cp index.html _dashboard_publish/${{ env.REPO_NAME }}/${{ env.CI_BRANCH }}
+
+      # Create GitHub App token for pushing to external dashboard repo.
+      # The 'repositories' parameter is required to grant access to repos
+      # other than the one where the workflow is running.
+      - name: Setup easyscience[bot]
+        id: bot
+        uses: ./.github/actions/setup-easyscience-bot
+        with:
+          app-id: ${{ vars.EASYSCIENCE_APP_ID }}
+          private-key: ${{ secrets.EASYSCIENCE_APP_KEY }}
+          repositories: |
+            ${{ github.event.repository.name }}
+            dashboard
+
+      # Push to external dashboard repository with retry logic.
+      # Retry is needed to handle transient GitHub API/authentication issues
+      # that occasionally cause 403 errors when multiple workflows push concurrently.
+      # Uses personal_token (not github_token) as GITHUB_TOKEN cannot access external repos.
+      - name:
+          Push to ${{ env.REPO_OWNER }}/dashboard/${{ env.REPO_NAME }}/${{ env.CI_BRANCH
+          }}
+        shell: bash
+        env:
+          DASHBOARD_COMMIT_MESSAGE: ${{ env.CI_BRANCH }}
+          DASHBOARD_GIT_USER_EMAIL:
+            ${{ vars.EASYSCIENCE_APP_ID }}+easyscience[bot]@users.noreply.github.com
+          DASHBOARD_PUSH_ATTEMPTS: '3'
+          DASHBOARD_PUSH_DELAY_SECONDS: '15'
+          DASHBOARD_PUBLISH_BRANCH: master
+          DASHBOARD_REMOTE_REPOSITORY: ${{ env.REPO_OWNER }}/dashboard
+          DASHBOARD_SOURCE_DIR: ./_dashboard_publish
+          DASHBOARD_TOKEN: ${{ steps.bot.outputs.token }}
+        run: bash ./.github/scripts/publish-dashboard.sh
+
+      - name: Add dashboard link to summary
+        run: |
+          URL="https://${{ env.REPO_OWNER }}.github.io/dashboard/${{ env.REPO_NAME }}/${{ env.CI_BRANCH }}"
+          echo "Dashboard link: [$URL]($URL)" >> $GITHUB_STEP_SUMMARY

easydiffraction-0.18.0/.github/workflows/docs.yml

@@ -0,0 +1,194 @@
+# This workflow builds and deploys documentation for the project.
+#
+# Overview:
+#  - Converts tutorial Python scripts to Jupyter notebooks and executes them.
+#  - Builds the documentation site using MkDocs with the Material theme.
+#  - Uploads the built site as an artifact for local inspection.
+#  - Deploys versioned documentation to the gh-pages branch using Mike:
+#    - For release tags (v*): deploys to a versioned folder (e.g., /0.9.1/) and updates /latest/.
+#    - For branches: deploys to /dev/.
+#
+# The action summary page will contain a link to the built artifact for downloading
+# and inspecting, as well as a link to the deployed documentation site.
+
+name: Docs build and deployment
+
+on:
+  # Trigger the workflow on push
+  push:
+    # Selected branches
+    branches: [develop] # master and main are already verified in PR
+    # Runs on creating a new tag starting with 'v', e.g. 'v1.0.3'
+    tags: ['v*']
+  # Trigger the workflow on pull request
+  pull_request:
+    # Selected branches
+    branches: [master, main, develop]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# - Non-tagged pushes and pull requests all use `docs-dev` group, so
+#   they cancel each other.
+# - Tagged pushes use their own group like docs-v1.2.3, so they do not
+#   cancel non-tagged runs, and non-tagged runs do not cancel them.
+concurrency:
+  group: >-
+    ${{ startsWith(github.ref, 'refs/tags/v')
+      && format('docs-{0}', github.ref_name)
+      || 'docs-dev' }}
+  cancel-in-progress: true
+
+# Set the environment variables to be used in all jobs defined in this workflow
+env:
+  # CI_BRANCH - the branch name (used in mkdocs.yml)
+  # For PRs: github.head_ref is the source branch
+  # For pushes: github.ref_name is the branch
+  # For tags: github.ref_name is the tag name
+  # GITHUB_REPOSITORY - the repository name (used in mkdocs.yml)
+  # NOTEBOOKS_DIR - the directory containing the Jupyter notebooks (used in mkdocs.yml)
+  DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+  DEVELOP_BRANCH: develop
+  CI_BRANCH: ${{ github.head_ref || github.ref_name }}
+  IS_RELEASE_TAG: ${{ startsWith(github.ref, 'refs/tags/v') }}
+  GITHUB_REPOSITORY: ${{ github.repository }}
+  NOTEBOOKS_DIR: tutorials
+
+jobs:
+  # Single job that builds and deploys documentation.
+  # Uses macOS runner for consistent Plotly chart rendering.
+  build-deploy-docs:
+    runs-on: ubuntu-latest # macos-latest
+
+    permissions:
+      contents: write # Required for pushing to the gh-pages branch
+
+    steps:
+      # Setting DOCS_VERSION to be used in mkdocs.yml, and then in the
+      # main.html template. It defines the versioned docs subfolder name
+      # in the gh-pages branch. If it's a release tag, use the version
+      # number without the 'v' prefix, otherwise use 'dev'.
+      # Setting RELEASE_VERSION to be used in mkdocs.yml to show
+      # the latest release version in the index.md file. If it's a
+      # release tag, use the tag name, otherwise use the branch name
+      # for development builds.
+      - name: Set extra env variables
+        shell: bash
+        run: |
+          if [[ "${IS_RELEASE_TAG}" == "true" ]]; then
+            RELEASE_VERSION="${GITHUB_REF_NAME}"
+            DOCS_VERSION="${RELEASE_VERSION#v}"
+          else
+            RELEASE_VERSION="${CI_BRANCH}"
+            DOCS_VERSION="dev"
+          fi
+          echo "RELEASE_VERSION=${RELEASE_VERSION}" >> "$GITHUB_ENV"
+          echo "DOCS_VERSION=${DOCS_VERSION}" >> "$GITHUB_ENV"
+
+      # Check out the repository source code.
+      # Note: The gh-pages branch is fetched separately later for mike deployment.
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      # Activate dark mode to create documentation with Plotly charts in dark mode
+      # Need a better solution to automatically switch the chart colour theme based on the mkdocs material switcher
+      # Something similar to mkdocs_plotly_plugin https://haoda-li.github.io/mkdocs-plotly-plugin/,
+      # but for generating documentation from notepads
+      #- name: Activate dark mode
+      #  run: |
+      #    brew install dark-mode
+      #    dark-mode status
+      #    dark-mode on
+      #    dark-mode status
+
+      # Set up the pixi package manager and install dependencies from pixi.toml.
+      # Uses frozen lockfile to ensure reproducible builds.
+      - name: Set up pixi
+        uses: ./.github/actions/setup-pixi
+      # Pre-import the main package to exclude info messages from the docs
+      # E.g., Matplotlib may print messages to stdout/stderr when first
+      # imported. This step allows to avoid "Matplotlib is building the font
+      # cache" messages during notebook execution.
+      - name: Pre-build site step
+        run: pixi run python -c "import easydiffraction"
+
+      # Prepare the Jupyter notebooks for documentation (strip output, etc.).
+      - name: Prepare notebooks
+        run: pixi run notebook-prepare
+
+      # Execute all Jupyter notebooks to generate output cells (plots, tables, etc.).
+      # Uses multiple cores for parallel execution to speed up the process.
+      - name: Run notebooks
+        # if: false # Temporarily disabled to speed up the docs build
+        run: pixi run notebook-exec-ci
+
+      # Sync the canonical Three.js snapshot into the docs assets so
+      # MkDocs can serve it (belt-and-braces; docs-build also depends on
+      # this task).
+      - name: Sync vendored JS into docs assets
+        run: pixi run docs-sync-vendored-js
+
+      # Build the static files for the documentation site for local inspection
+      # Input: docs/ directory containing the Markdown files
+      # Output: site/ directory containing the generated HTML files
+      - name: Build site for local check
+        run: pixi run docs-build-local
+
+      # Upload the static files from the site/ directory to be used for
+      # local check
+      - name: Upload built site as artifact
+        uses: ./.github/actions/upload-artifact
+        with:
+          name: site-local_easydiffraction-lib-${{ env.RELEASE_VERSION }}
+          path: docs/site/
+
+      # Create GitHub App token for pushing to gh-pages as easyscience[bot].
+      - name: Setup easyscience[bot]
+        id: bot
+        uses: ./.github/actions/setup-easyscience-bot
+        with:
+          app-id: ${{ vars.EASYSCIENCE_APP_ID }}
+          private-key: ${{ secrets.EASYSCIENCE_APP_KEY }}
+
+      # Configure git identity and remote URL so mike pushes as easyscience[bot].
+      - name: Configure git for pushing
+        run: |
+          set -euo pipefail
+          git config user.name "easyscience[bot]"
+          git config user.email "${{ vars.EASYSCIENCE_APP_ID }}+easyscience[bot]@users.noreply.github.com"
+          git remote set-url origin "https://x-access-token:${{ steps.bot.outputs.token }}@github.com/${{ github.repository }}.git"
+
+      # Fetch the gh-pages branch to ensure mike has the latest remote state.
+      # This is required because the checkout step only fetches the source branch,
+      # not the gh-pages branch that mike needs to update.
+      - name: Fetch gh-pages branch
+        run: |
+          git fetch origin gh-pages:gh-pages 2>/dev/null || true
+
+      # Deploy versioned documentation using mike (MkDocs plugin for versioning).
+      # - For release tags (v*): deploys to versioned folder (e.g., /0.9.1/) and aliases to /latest/.
+      # - For branches: deploys to /dev/.
+      # The "${RELEASE_VERSION#v}" syntax strips the 'v' prefix (v0.9.1 -> 0.9.1).
+      # Also sets 'latest' as the default version for the version selector.
+      - name: Rebuild and deploy docs with mike
+        run: |
+          # Exit on error (-e), undefined vars (-u), and pipeline failures (pipefail)
+          set -euo pipefail
+
+          REPO_NAME="${{ github.event.repository.name }}"
+          BASE_URL="https://easyscience.github.io/${REPO_NAME}"
+
+          # Deploy the release version and update the "latest" alias
+          if [[ "${IS_RELEASE_TAG}" == "true" ]]; then
+            pixi run docs-deploy-pre "${RELEASE_VERSION#v}" latest
+            pixi run docs-set-default-pre latest
+            DEPLOYMENT_URL="${BASE_URL}/latest"
+
+          # Deploy/update the "dev" alias (or whatever your convention is)
+          else
+            pixi run docs-deploy-pre dev
+            DEPLOYMENT_URL="${BASE_URL}/dev"
+
+          fi
+
+          # Add links to the action summary page for easy access
+          echo "🔗 deployment url [${DEPLOYMENT_URL}](${DEPLOYMENT_URL})" >> "${GITHUB_STEP_SUMMARY}"

easydiffraction-0.18.0/.github/workflows/issues-labels.yml

@@ -0,0 +1,40 @@
+# Verifies if the current issue has at least one `[scope]` label and one
+# `[priority]` label. If either is missing, the workflow adds a reminder label.
+
+name: Issue labels check
+
+on:
+  issues:
+    types: [opened, labeled, unlabeled]
+
+permissions:
+  issues: write
+
+jobs:
+  check-labels:
+    runs-on: ubuntu-latest
+
+    concurrency:
+      group: issue-labels-${{ github.event.issue.number }}
+      cancel-in-progress: true
+
+    steps:
+      - name: Ensure [scope] label
+        uses: Rindrics/expect-label-prefix@v1.2.1
+        with:
+          repository_full_name: ${{ github.repository }}
+          token: ${{ github.token }}
+          label_prefix: '[scope]'
+          label_separator: ' '
+          add_label: 'true'
+          default_label: '[scope] ⚠️ label needed'
+
+      - name: Ensure [priority] label
+        uses: Rindrics/expect-label-prefix@v1.2.1
+        with:
+          repository_full_name: ${{ github.repository }}
+          token: ${{ github.token }}
+          label_prefix: '[priority]'
+          label_separator: ' '
+          add_label: 'true'
+          default_label: '[priority] ⚠️ label needed'

easydiffraction-0.18.0/.github/workflows/pr-labels.yml

@@ -0,0 +1,45 @@
+# Verifies if a pull request has at least one label from a set of valid
+# labels before it can be merged.
+#
+# The label validation is delegated to `mheap/github-action-required-labels`,
+# which checks the current PR labels via the GitHub API and can add or update a
+# PR comment when the required label set is missing.
+
+name: PR labels check
+
+on:
+  pull_request_target:
+    types: [opened, labeled, unlabeled, synchronize]
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  check-labels:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup easyscience[bot]
+        id: bot
+        uses: ./.github/actions/setup-easyscience-bot
+        with:
+          app-id: ${{ vars.EASYSCIENCE_APP_ID }}
+          private-key: ${{ secrets.EASYSCIENCE_APP_KEY }}
+
+      - uses: mheap/github-action-required-labels@v5
+        with:
+          token: ${{ steps.bot.outputs.token }}
+          add_comment: true
+          mode: minimum
+          count: 1
+          labels: |
+            [bot] release
+            [scope] bug
+            [scope] documentation
+            [scope] enhancement
+            [scope] maintenance
+            [scope] significant

easydiffraction-0.18.0/.github/workflows/release-pr.yml

@@ -0,0 +1,55 @@
+# This workflow creates an automated release PR from a source branch into the default branch.
+#
+# Usage:
+#   - Triggered manually via workflow_dispatch.
+#   - Creates a PR titled "Release: merge <source> into <default>".
+#   - Adds the label "[bot] release" so it is excluded from changelogs.
+#   - The PR body makes clear that this is automation only (no review needed).
+
+name: 'Release PR (develop → master)'
+
+on:
+  workflow_dispatch:
+    inputs:
+      source_branch:
+        description: 'Source branch to create PR from'
+        required: false
+        default: 'develop'
+        type: string
+
+permissions:
+  contents: read
+  pull-requests: write
+
+env:
+  DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+  SOURCE_BRANCH: ${{ inputs.source_branch || 'develop' }}
+
+jobs:
+  create-pull-request:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout ${{ env.SOURCE_BRANCH }} branch
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ env.SOURCE_BRANCH }}
+
+      - name: Setup easyscience[bot]
+        id: bot
+        uses: ./.github/actions/setup-easyscience-bot
+        with:
+          app-id: ${{ vars.EASYSCIENCE_APP_ID }}
+          private-key: ${{ secrets.EASYSCIENCE_APP_KEY }}
+
+      - name: Create PR from ${{ env.SOURCE_BRANCH }} to ${{ env.DEFAULT_BRANCH }}
+        env:
+          GH_TOKEN: ${{ steps.bot.outputs.token }}
+        run: |
+          gh pr create \
+            --base ${{ env.DEFAULT_BRANCH }} \
+            --head ${{ env.SOURCE_BRANCH }} \
+            --title "🎉 Release: merge ${{ env.SOURCE_BRANCH }} into ${{ env.DEFAULT_BRANCH }}" \
+            --label "[bot] release" \
+            --body "This PR is created automatically to trigger the release pipeline. It merges the accumulated changes from \`${{ env.SOURCE_BRANCH }}\` into \`${{ env.DEFAULT_BRANCH }}\`.
+
+            ⚠️ It is labeled \`[bot] release\` and is excluded from release notes and version bump logic."