diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..61da6e8 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,343 @@ +# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist +# +# Copyright 2022-2024, axodotdev +# SPDX-License-Identifier: MIT or Apache-2.0 +# +# CI that: +# +# * checks for a Git Tag that looks like a release +# * builds artifacts with dist (archives, installers, hashes) +# * uploads those artifacts to temporary workflow zip +# * on success, uploads the artifacts to a GitHub Release +# +# Note that the GitHub Release will be created with a generated +# title/body based on your changelogs. + +name: Release +permissions: + "contents": "write" + +# This task will run whenever you push a git tag that looks like a version +# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc. +# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where +# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION +# must be a Cargo-style SemVer Version (must have at least major.minor.patch). +# +# If PACKAGE_NAME is specified, then the announcement will be for that +# package (erroring out if it doesn't have the given version or isn't dist-able). +# +# If PACKAGE_NAME isn't specified, then the announcement will be for all +# (dist-able) packages in the workspace with that version (this mode is +# intended for workspaces with only one dist-able package, or with all dist-able +# packages versioned/released in lockstep). +# +# If you push multiple tags at once, separate instances of this workflow will +# spin up, creating an independent announcement for each one. However, GitHub +# will hard limit this to 3 tags per commit, as it will assume more tags is a +# mistake. +# +# If there's a prerelease-style suffix to the version, then the release(s) +# will be marked as a prerelease. +on: + pull_request: + push: + tags: + - '**[0-9]+.[0-9]+.[0-9]+*' + +jobs: + # Run 'dist plan' (or host) to determine what tasks we need to do + plan: + runs-on: "ubuntu-22.04" + outputs: + val: ${{ steps.plan.outputs.manifest }} + tag: ${{ !github.event.pull_request && github.ref_name || '' }} + tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} + publishing: ${{ !github.event.pull_request }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install dist + # we specify bash to get pipefail; it guards against the `curl` command + # failing. otherwise `sh` won't catch that `curl` returned non-0 + shell: bash + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.30.3/cargo-dist-installer.sh | sh" + - name: Cache dist + uses: actions/upload-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/dist + # sure would be cool if github gave us proper conditionals... + # so here's a doubly-nested ternary-via-truthiness to try to provide the best possible + # functionality based on whether this is a pull_request, and whether it's from a fork. + # (PRs run on the *source* but secrets are usually on the *target* -- that's *good* + # but also really annoying to build CI around when it needs secrets to work right.) + - id: plan + run: | + dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json + echo "dist ran successfully" + cat plan-dist-manifest.json + echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v4 + with: + name: artifacts-plan-dist-manifest + path: plan-dist-manifest.json + + # Build and packages all the platform-specific things + build-local-artifacts: + name: build-local-artifacts (${{ join(matrix.targets, ', ') }}) + # Let the initial task tell us to not run (currently very blunt) + needs: + - plan + if: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix.include != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }} + strategy: + fail-fast: false + # Target platforms/runners are computed by dist in create-release. + # Each member of the matrix has the following arguments: + # + # - runner: the github runner + # - dist-args: cli flags to pass to dist + # - install-dist: expression to run to install dist on the runner + # + # Typically there will be: + # - 1 "global" task that builds universal installers + # - N "local" tasks that build each platform's binaries and platform-specific installers + matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }} + runs-on: ${{ matrix.runner }} + container: ${{ matrix.container && matrix.container.image || null }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json + steps: + - name: enable windows longpaths + run: | + git config --global core.longpaths true + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install Rust non-interactively if not already installed + if: ${{ matrix.container }} + run: | + if ! command -v cargo > /dev/null 2>&1; then + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y + echo "$HOME/.cargo/bin" >> $GITHUB_PATH + fi + - name: Install dist + run: ${{ matrix.install_dist.run }} + # Get the dist-manifest + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - name: Install dependencies + run: | + ${{ matrix.packages_install }} + - name: Build artifacts + run: | + # Actually do builds and make zips and whatnot + dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json + echo "dist ran successfully" + - id: cargo-dist + name: Post-build + # We force bash here just because github makes it really hard to get values up + # to "real" actions without writing to env-vars, and writing to env-vars has + # inconsistent syntax between shell and powershell. + shell: bash + run: | + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-local-${{ join(matrix.targets, '_') }} + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + + # Build and package all the platform-agnostic(ish) things + build-global-artifacts: + needs: + - plan + - build-local-artifacts + runs-on: "ubuntu-22.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Get all the local artifacts for the global tasks to use (for e.g. checksums) + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: cargo-dist + shell: bash + run: | + dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json + echo "dist ran successfully" + + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-global + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + # Determines if we should publish/announce + host: + needs: + - plan + - build-local-artifacts + - build-global-artifacts + # Only run if we're "publishing", and only if plan, local and global didn't fail (skipped is fine) + if: ${{ always() && needs.plan.result == 'success' && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + runs-on: "ubuntu-22.04" + outputs: + val: ${{ steps.host.outputs.manifest }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Fetch artifacts from scratch-storage + - name: Fetch artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: host + shell: bash + run: | + dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json + echo "artifacts uploaded and released successfully" + cat dist-manifest.json + echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v4 + with: + # Overwrite the previous copy + name: artifacts-dist-manifest + path: dist-manifest.json + # Create a GitHub Release while uploading all files to it + - name: "Download GitHub Artifacts" + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: artifacts + merge-multiple: true + - name: Cleanup + run: | + # Remove the granular manifests + rm -f artifacts/*-dist-manifest.json + - name: Create GitHub Release + env: + PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}" + ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}" + ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}" + RELEASE_COMMIT: "${{ github.sha }}" + run: | + # Write and read notes from a file to avoid quoting breaking things + echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt + + gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/* + + publish-homebrew-formula: + needs: + - plan + - host + runs-on: "ubuntu-22.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PLAN: ${{ needs.plan.outputs.val }} + GITHUB_USER: "axo bot" + GITHUB_EMAIL: "admin+bot@axo.dev" + if: ${{ !fromJson(needs.plan.outputs.val).announcement_is_prerelease || fromJson(needs.plan.outputs.val).publish_prereleases }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: true + repository: "davelet/homebrew-gim" + token: ${{ secrets.HOMEBREW_TAP_TOKEN }} + # So we have access to the formula + - name: Fetch homebrew formulae + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: Formula/ + merge-multiple: true + # This is extra complex because you can make your Formula name not match your app name + # so we need to find releases with a *.rb file, and publish with that filename. + - name: Commit formula files + run: | + git config --global user.name "${GITHUB_USER}" + git config --global user.email "${GITHUB_EMAIL}" + + for release in $(echo "$PLAN" | jq --compact-output '.releases[] | select([.artifacts[] | endswith(".rb")] | any)'); do + filename=$(echo "$release" | jq '.artifacts[] | select(endswith(".rb"))' --raw-output) + name=$(echo "$filename" | sed "s/\.rb$//") + version=$(echo "$release" | jq .app_version --raw-output) + + export PATH="/home/linuxbrew/.linuxbrew/bin:$PATH" + brew update + # We avoid reformatting user-provided data such as the app description and homepage. + brew style --except-cops FormulaAudit/Homepage,FormulaAudit/Desc,FormulaAuditStrict --fix "Formula/${filename}" || true + + git add "Formula/${filename}" + git commit -m "${name} ${version}" + done + git push + + announce: + needs: + - plan + - host + - publish-homebrew-formula + # use "always() && ..." to allow us to wait for all publish jobs while + # still allowing individual publish jobs to skip themselves (for prereleases). + # "host" however must run to completion, no skipping allowed! + if: ${{ always() && needs.host.result == 'success' && (needs.publish-homebrew-formula.result == 'skipped' || needs.publish-homebrew-formula.result == 'success') }} + runs-on: "ubuntu-22.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive diff --git a/Cargo.lock b/Cargo.lock index 3c4ab76..17ae757 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -441,7 +441,7 @@ checksum = "07e28edb80900c19c28f1072f2e8aeca7fa06b23cd4169cefe1af5aa3260783f" [[package]] name = "git-intelligence-message" -version = "2.0.0" +version = "2.1.0" dependencies = [ "chrono", "clap", diff --git a/Cargo.toml b/Cargo.toml index b16b6b3..8d8348f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,12 @@ [package] name = "git-intelligence-message" -version = "2.0.0" +version = "2.1.0" edition = "2024" description = "An advanced Git commit message generation utility with AI assistance" authors = ["Sheldon.Wei"] license = "MIT" repository = "https://github.com/davelet/git-intelligence-message" +homepage = "https://git-intelligence-message.pages.dev/" readme = "README.md" keywords = ["git", "commit", "ai", "cli"] categories = ["command-line-utilities"] @@ -16,6 +17,11 @@ lto = true codegen-units = 1 panic = "abort" +# The profile that 'dist' will build with +[profile.dist] +inherits = "release" +lto = "thin" + [target.'cfg(windows)'.rustflags] rustflags = ["-C", "target-feature=+crt-static"] diff --git a/dist-workspace.toml b/dist-workspace.toml new file mode 100644 index 0000000..f5284f1 --- /dev/null +++ b/dist-workspace.toml @@ -0,0 +1,23 @@ +[workspace] +members = ["cargo:."] + +# Config for 'dist' +[dist] +# The preferred dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.30.3" +# CI backends to support +ci = "github" +# The installers to generate for each app +installers = ["shell", "powershell", "homebrew"] +# A GitHub repo to push Homebrew formulas to +tap = "davelet/homebrew-gim" +# A GitHub repo to push Scoop manifests to +scoop-bucket = "davelet/scoop-gim" +# Target platforms to build apps for (Rust target-triple syntax) +targets = ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "aarch64-pc-windows-msvc", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl", "x86_64-pc-windows-msvc"] +# Path that installers should place binaries in +install-path = "CARGO_HOME" +# Publish jobs to run in CI +publish-jobs = ["homebrew"] +# Whether to install an updater program +install-updater = false diff --git a/docs/content/changelog.md b/docs/content/changelog.md index 8b0ef64..7f01ca8 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -1,8 +1,12 @@ # Changelog +## [2.1.0] - 2026-02-12 + +- **M Chip Support for Mac**: Release build for M chip Macs. + + ## [2.0.0] - 2026-02-02 -### New Features - **Local Project Prompts**: Added support for `.gim` directory in git repository root for project-specific prompt files - **Custom Prompts**: Added `--diff-prompt` and `--subject-prompt` command-line options to override default AI prompts - Enhanced prompt loading with local `.gim` directory support for project-specific prompts diff --git a/src/commands/prompt.rs b/src/commands/prompt.rs index 38aa8fc..bc5b540 100644 --- a/src/commands/prompt.rs +++ b/src/commands/prompt.rs @@ -4,6 +4,7 @@ use std::{fs, io, path::PathBuf, process::Command}; use crate::config::constants::{DIFF_PROMPT_FILE, SUBJECT_PROMPT_FILE}; use crate::core::git; +use crate::utils::output; fn file_dirs() -> io::Result { directory::config_dir() @@ -16,7 +17,7 @@ fn get_local_gim_prompt_files() -> Option<(PathBuf, PathBuf)> { if gim_dir.is_dir() { let diff_prompt_path = gim_dir.join(DIFF_PROMPT_FILE); let subject_prompt_path = gim_dir.join(SUBJECT_PROMPT_FILE); - + // Check if at least one of the prompt files exists if diff_prompt_path.exists() || subject_prompt_path.exists() { return Some((diff_prompt_path, subject_prompt_path)); @@ -86,24 +87,34 @@ fn trim_subject_prompt() -> String { pub fn get_diff_prompt(custom_prompt: Option<&str>) -> String { // If custom prompt is provided, use it directly if let Some(custom) = custom_prompt { + output::print_verbose("Using custom diff prompt from command line argument"); return custom.to_string(); } - + let trimmed = trim_diff_prompt(); - + // First, check for local .gim directory if let Some((local_diff_path, _)) = get_local_gim_prompt_files() { if local_diff_path.exists() { match fs::read_to_string(&local_diff_path) { - Ok(content) => return content, + Ok(content) => { + output::print_verbose(&format!( + "Using diff prompt from local .gim directory: {}", + local_diff_path.display() + )); + return content; + } Err(e) => { - eprintln!("Failed to read diff prompt from local .gim directory: {}", e); + eprintln!( + "Failed to read diff prompt from local .gim directory: {}", + e + ); // Continue to fallback to config directory } } } } - + // Fallback to config directory let path = match file_dirs() { Ok(p) => p.join(DIFF_PROMPT_FILE), @@ -114,16 +125,24 @@ pub fn get_diff_prompt(custom_prompt: Option<&str>) -> String { }; if !path.exists() { - if let Err(e) = fs::write(&path, trimmed.clone()) { - eprintln!("Failed to write diff prompt to file: {}", e); - } + output::print_verbose("Using built-in default diff prompt"); return trimmed; } - fs::read_to_string(path).unwrap_or_else(|e| { - eprintln!("Failed to read diff prompt from file: {}", e); - trimmed - }) + match fs::read_to_string(&path) { + Ok(content) => { + output::print_verbose(&format!( + "Using diff prompt from config directory: {}", + path.display() + )); + content + } + Err(e) => { + eprintln!("Failed to read diff prompt from file: {}", e); + output::print_verbose("Using built-in default diff prompt"); + trimmed + } + } } /// Returns the subject prompt string, reading from local .gim directory first if available, @@ -140,24 +159,34 @@ pub fn get_diff_prompt(custom_prompt: Option<&str>) -> String { pub fn get_subject_prompt(custom_prompt: Option<&str>) -> String { // If custom prompt is provided, use it directly if let Some(custom) = custom_prompt { + output::print_verbose("Using custom subject prompt from command line argument"); return custom.to_string(); } - + let trimmed = trim_subject_prompt(); - + // First, check for local .gim directory if let Some((_, local_subject_path)) = get_local_gim_prompt_files() { if local_subject_path.exists() { match fs::read_to_string(&local_subject_path) { - Ok(content) => return content, + Ok(content) => { + output::print_verbose(&format!( + "Using subject prompt from local .gim directory: {}", + local_subject_path.display() + )); + return content; + } Err(e) => { - eprintln!("Failed to read subject prompt from local .gim directory: {}", e); + eprintln!( + "Failed to read subject prompt from local .gim directory: {}", + e + ); // Continue to fallback to config directory } } } } - + // Fallback to config directory let path = match file_dirs() { Ok(p) => p.join(SUBJECT_PROMPT_FILE), @@ -168,16 +197,24 @@ pub fn get_subject_prompt(custom_prompt: Option<&str>) -> String { }; if !path.exists() { - if let Err(e) = fs::write(&path, trimmed.clone()) { - eprintln!("Failed to write subject prompt to file: {}", e); - } + output::print_verbose("Using built-in default subject prompt"); return trimmed; } - fs::read_to_string(path).unwrap_or_else(|e| { - eprintln!("Failed to read subject prompt from file: {}", e); - trimmed - }) + match fs::read_to_string(&path) { + Ok(content) => { + output::print_verbose(&format!( + "Using subject prompt from config directory: {}", + path.display() + )); + content + } + Err(e) => { + eprintln!("Failed to read subject prompt from file: {}", e); + output::print_verbose("Using built-in default subject prompt"); + trimmed + } + } } /// Deletes the prompt files. @@ -207,9 +244,7 @@ pub fn open_config_directory() -> io::Result<()> { let config_dir = directory::config_dir()?; // Open the directory with default file manager if cfg!(target_os = "macos") { - Command::new("open") - .arg(&config_dir) - .status()?; + Command::new("open").arg(&config_dir).status()?; } else if cfg!(target_os = "windows") { Command::new("explorer").arg(&config_dir).status()?; } else { @@ -283,8 +318,9 @@ pub fn handle_prompt_command( { return Err(std::io::Error::new( std::io::ErrorKind::NotFound, - "Failed to open file manager. Please specify an editor with --editor" - ).into()); + "Failed to open file manager. Please specify an editor with --editor", + ) + .into()); } } }