fix: complete interactive release script fixes and improvements #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

fxstein merged 25 commits into develop from feat/enhancement-improve-multichannel-release-process-20250630-132444

Jun 30, 2025

.github/workflows/release-channels.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -27,7 +27,7 @@ jobs:
  
          - name: Run tests

            run: |

              ./scripts/testing/run-tests.zsh

              ./scripts/testing/run-tests.zsh --force-clean

          - name: Update Homebrew Dev Channel

            env:

    @@ -56,7 +56,7 @@ jobs:
  
          - name: Run tests

            run: |

              ./scripts/testing/run-tests.zsh

              ./scripts/testing/run-tests.zsh --force-clean

          - name: Update Homebrew Beta Channel

            env:

    @@ -85,7 +85,7 @@ jobs:
  
          - name: Run tests

            run: |

              ./scripts/testing/run-tests.zsh

              ./scripts/testing/run-tests.zsh --force-clean

          - name: Update Homebrew Official Channel

            env:

.github/workflows/test.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -59,7 +59,7 @@ jobs: @@
           - name: "Run all unit tests"
             run: |
               echo "🧪 Running all unit tests..."
-              ./scripts/testing/run-unit-tests.zsh
+              ./scripts/testing/run-unit-tests.zsh --force-clean
           - name: "Upload unit test results"
             if: always()
@@ Expand Down @@

AI_INSTRUCTIONS.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -40,7 +40,7 @@ This document establishes the foundational architectural decisions and design pa
  
       - Commit and push all changes before proceeding

    3. **Use Full Release Script**

       - Always use `scripts/release/full-release.zsh` for releases

       - Always use `scripts/release/gitflow-release.zsh` for releases

       - Never run individual scripts unless specifically instructed

    4. **Output File Requirements** (CRITICAL)

    @@ -87,7 +87,7 @@ This document establishes the foundational architectural decisions and design pa
  
    ## Release Workflow Automation

    - When the user requests a release, always use the `./scripts/release/full-release.zsh` script to perform the entire release process (version bump, workflow trigger, monitoring) in a single, automated step.

    - When the user requests a release, always use the `./scripts/release/gitflow-release.zsh` script to perform the entire release process (version bump, workflow trigger, monitoring) in a single, automated step.

    - By default, all test runs should be performed as dry runs (using `--dry-run`), unless a real release is explicitly requested.

    - Do not run the bump-version, release, or monitor scripts individually unless specifically instructed.

    @@ -119,13 +119,36 @@ This document establishes the foundational architectural decisions and design pa
  
    - Use this awareness to ensure all work is properly linked to relevant issues and to provide accurate context during development and communication.

    ## Release Script Automation

    - Always use `scripts/release/full-release.zsh` for all release and dry-run operations. This script performs version bumping, workflow triggering, and monitoring in a single automated process.

    - For dry runs, use: `./scripts/release/full-release.zsh --dry-run` (this will run non-interactively and monitor the workflow).

    - Default to this format whenever the user requests a release or dry run of the release process.

    - **ALWAYS use the new simplified top-level release script**: `./scripts/release/release.zsh` for all release and dry-run operations

    - **For AI/Automation**: Use batch mode with all parameters specified: `./scripts/release/release.zsh --batch <type> --prev <version> [options]`

    - **For Interactive Use**: Use interactive mode: `./scripts/release/release.zsh` (default) or `./scripts/release/release.zsh --interactive`

    - **Release Types**: 

      - `dry-run`: Test release process without actual release (any branch)

      - `official`: Production releases (main/develop/release/* branches)

      - `beta`: Beta releases (release/* branches)

      - `dev`: Development releases (feature/*/fix/* branches)

    - **Default to batch mode for automation** whenever the user requests a release or dry run of the release process

    - **IMPORTANT**: Before any release or dry run, always check the entire `scripts/release/` directory for changes. Commit and push all changes in `scripts/release/` before running a release or dry run. The GitHub workflow uses the repository state on GitHub, not local changes. Failure to commit and push will result in the workflow using outdated scripts.

    - If a full release (without `--dry-run`) is requested and there are changes in `scripts/release/`, first commit and push those changes, then perform a dry run. Only proceed with the real release if the dry run completes successfully.

    - Whenever a release is requested (dry-run or real), always create or update a file in `docs/release` with a summary of major changes since the requested previous release. The filename must match the convention used by the release process: `docs/release/latest-major-changes-since-<BASE>.md` (where `<BASE>` is the previous version, no leading 'v'). This file must be created every time a release is requested, before the release process starts.

    **Examples for AI/Automation:**

    ```zsh

    # Dry run for testing

    ./scripts/release/release.zsh --batch dry-run --prev 01.50.00 --minor

    # Official release with monitoring

    ./scripts/release/release.zsh --batch official --prev 01.50.00 --minor --monitor

    # Beta release with specific version

    ./scripts/release/release.zsh --batch beta --prev 01.50.00 --version 01.51.00

    # Development release

    ./scripts/release/release.zsh --batch dev --prev 01.50.00 --patch

    ```

    **Legacy Scripts**: The old `scripts/release/gitflow-release.zsh` is now the unified release script and should be used for all release operations. The `full-release.zsh` script has been deprecated and its functionality merged into `gitflow-release.zsh`.

    ## GitHub Issue Management

    - Whenever a new GitHub issue is created, immediately run `scripts/maintenance/generate-issues-markdown.zsh` to update the local Markdown issue list.

    - After generating the issue list, read the output file (`output/github_issues.md`) to ensure you are memorizing and referencing the latest issues in all future work and communication.

    @@ -587,7 +610,11 @@ What happens after approval/rejection.
  
    - If working on releases, summaries, or version management, read `docs/release/RELEASE_SUMMARY_INSTRUCTIONS.md`

    - This document defines required content and formatting for release summaries

    ### **Step 4: Read Next Steps** (if applicable)

    ### **Step 4: Read Release System Documentation** (if applicable)

    - If working on releases, deployment, or release automation, read `docs/RELEASE_SYSTEM.md`

    - This document defines the new simplified release system with interactive and batch modes

    ### **Step 5: Read Next Steps** (if applicable)

    - If starting new work or providing progress updates, read `docs/NEXT_STEPS.md`

    - This document tracks current priorities and dependencies

    @@ -605,7 +632,8 @@ After reading all required documents, respond with:
  
    1. **AI Instructions** ✅ - [Brief summary of key requirements and standards]

    2. **Design Principles** ✅ - [Brief summary of core principles and architectural decisions]

    3. **Release Summary Instructions** ✅ - [Brief summary if applicable to current work]

    4. **Next Steps** ✅ - [Brief summary if applicable to current work]

    4. **Release System Documentation** ✅ - [Brief summary if applicable to current work]

    5. **Next Steps** ✅ - [Brief summary if applicable to current work]

    I'm now fully equipped with all mandatory reading requirements and ready to proceed.

    ```

    @@ -623,7 +651,8 @@ I'm now fully equipped with all mandatory reading requirements and ready to proc
  
    1. **AI Instructions** - Read complete `AI_INSTRUCTIONS.md`

    2. **Design Principles** - Read complete `docs/architecture/DESIGN_PRINCIPLES.md`

    3. **Release Summary Instructions** - Read `docs/release/RELEASE_SUMMARY_INSTRUCTIONS.md` (if working on releases/summaries)

    4. **Next Steps** - Read `docs/NEXT_STEPS.md` (if starting new work or providing progress updates)

    4. **Release System Documentation** - Read `docs/RELEASE_SYSTEM.md` (if working on releases/deployment)

    5. **Next Steps** - Read `docs/NEXT_STEPS.md` (if starting new work or providing progress updates)

    ### **Mandatory Confirmation Format:**

    After reading ALL required documents, you MUST respond with this exact format:

    @@ -634,7 +663,8 @@ After reading ALL required documents, you MUST respond with this exact format:
  
    1. **AI Instructions** ✅ - [Brief summary of key requirements and standards]

    2. **Design Principles** ✅ - [Brief summary of core principles and architectural decisions]

    3. **Release Summary Instructions** ✅ - [Brief summary if applicable to current work]

    4. **Next Steps** ✅ - [Brief summary if applicable to current work]

    4. **Release System Documentation** ✅ - [Brief summary if applicable to current work]

    5. **Next Steps** ✅ - [Brief summary if applicable to current work]

    I'm now fully equipped with all mandatory reading requirements and ready to proceed.

    ```

docs/RELEASE_PROCESS.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -86,9 +86,9 @@ The release automation system automatically:
  
    ### 2. Legacy Scripts (for reference only)

    The following scripts are now called internally by `full-release.zsh` and should not be run directly unless for advanced troubleshooting:

    The following scripts are now called internally by `gitflow-release.zsh` and should not be run directly unless for advanced troubleshooting:

    - `scripts/release/bump-version.zsh`

    - `scripts/release/release.zsh`

    - `scripts/release/trigger-workflow.zsh`

    - `scripts/release/monitor-release.zsh`

    ### 3. Monitoring Output

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: complete interactive release script fixes and improvements #84

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!