### Install Changie from Source using Go Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Download and install the changie binary from the main branch using Go's install command. ```sh go install github.com/miniscruff/changie@latest ``` -------------------------------- ### Install Changie using UBI Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Install Changie binaries directly from GitHub releases using the UBI (universal binary installer) tool. ```sh ubi --project miniscruff/changie --in /binary/path ``` -------------------------------- ### Install Changie with Winget on Windows Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Install changie on Windows using the winget package manager. ```sh winget install miniscruff.changie ``` -------------------------------- ### Install Changie with Scoop on Windows Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Install changie on Windows using the Scoop package manager by first adding the changie repository. ```sh scoop bucket add changie https://github.com/miniscruff/changie scoop install changie ``` -------------------------------- ### Run Tests with Make Source: https://github.com/miniscruff/changie/blob/main/CONTRIBUTING.md Execute all project tests using the make command. Ensure Go is installed. ```bash make test ``` -------------------------------- ### Install Changie via NPM Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Install Changie as a development dependency, globally, or run it directly using npx. ```sh npm i -D changie ``` ```sh npm i -g changie ``` ```sh npx changie ``` -------------------------------- ### Install Changie with Homebrew on macOS Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Install changie from the homebrew core repository on macOS. ```sh brew install changie ``` -------------------------------- ### Install Changie via AUR on ArchLinux Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Use the trizen AUR helper to install the changie package on ArchLinux. ```sh trizen -S changie ``` -------------------------------- ### Install Changie using Mise Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Manage changie installations using Mise, a polyglot version manager. This adds changie to your global or project-specific configuration. ```sh mise use changie ``` ```toml [tools] changie = "latest" ``` ```toml [tasks.fragment] tools.changie = "latest" run = "changie new" ``` -------------------------------- ### Configure package.json Version Replacement Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/nodejs.md Use this configuration in your Changie setup to automatically update the version in your `package.json` file. This is useful for ensuring your published package reflects the correct release version. The `{{.VersionNoPrefix}}` placeholder inserts the version without any leading 'v'. ```yaml replacements: - path: package.json find: ' "version": ".*",' replace: ' "version": "{{.VersionNoPrefix}}",' ``` -------------------------------- ### Trigger Release on CHANGELOG Update Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/release_trigger.md Configure your GitHub Actions workflow to trigger on pushes to the main branch, specifically when the CHANGELOG.md file is modified. This setup is ideal for automating release steps that depend on changelog updates. ```yaml on: push: branches: [ main ] # your default branch if different paths: [ CHANGELOG.md ] # your changelog file if different jobs: release: # do your releasing here ``` -------------------------------- ### Initialize changie Project Source: https://github.com/miniscruff/changie/blob/main/docs/guide/quick_start.md Run this command to bootstrap your project with a sample configuration file, header, and an empty changelog. ```sh changie init ``` -------------------------------- ### Serve Documentation Locally Source: https://github.com/miniscruff/changie/blob/main/CONTRIBUTING.md Build and serve the project documentation locally using MkDocs. This command allows for live reloading as changes are made. ```bash make docs-serve ``` -------------------------------- ### Run GoReleaser with Changie Notes and Skip Validate Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/goreleaser.md Execute GoReleaser, specifying the release notes path using `$(changie latest)` and using `--skip-validate` when not creating a Git tag. ```bash goreleaser --release-notes="changes/$(changie latest)" --skip-validate ``` -------------------------------- ### Run Changie using Docker Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Execute changie commands within a Docker container, mounting the current directory for source access. ```sh docker run \ --mount type=bind,source=$PWD,target=/src \ -w /src \ ghcr.io/miniscruff/changie \ latest ``` ```sh docker run \ --mount type=bind,source=$PWD,target=/src \ -w /src \ -it \ --user $(id -u ${USER}):$(id -g ${USER}) \ ghcr.io/miniscruff/changie \ new ``` -------------------------------- ### Lint Code with Make Source: https://github.com/miniscruff/changie/blob/main/CONTRIBUTING.md Run the linter to check for code style and quality issues. This is a required step before creating a pull request. ```bash make lint ``` -------------------------------- ### Create a New Change File Source: https://github.com/miniscruff/changie/blob/main/CONTRIBUTING.md Generate a new change file using Changie itself. This is necessary for changes affecting end-users. Run this command using 'go run' to use your local development version. ```bash go run main.go new ``` -------------------------------- ### Extract Kind Keys with YQ Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/yq.md Use this command to pull all 'key' values from the 'kinds' section of your .changie.yaml file. ```sh yq '.kinds[].key' .changie.yaml ``` -------------------------------- ### Extract Custom Keys with YQ Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/yq.md Use this command to extract 'key' values from the 'custom' section of your .changie.yaml file. ```sh yq '.custom[].key' .changie.yaml ``` -------------------------------- ### Use Changie GitHub Action Source: https://github.com/miniscruff/changie/blob/main/docs/guide/installation.md Integrate Changie into your GitHub Actions workflow to automate versioning tasks. ```yaml - name: Batch a new minor version uses: miniscruff/changie-action@VERSION # view action repo for latest version with: version: latest # use the latest changie version args: batch minor ``` -------------------------------- ### Set GoReleaser Current Tag with Changie Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/goreleaser.md Export the `GORELEASER_CURRENT_TAG` environment variable using `changie latest` to allow GitHub to create the release tag. ```bash export GORELEASER_CURRENT_TAG="$(changie latest)" ``` -------------------------------- ### Create a New Change File Source: https://github.com/miniscruff/changie/blob/main/docs/guide/quick_start.md Use this command when completing work on a feature, bugfix, or user-impacting change to generate a new change file. ```sh changie new ``` -------------------------------- ### Validate Changie Fragment with GitHub Action Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/ci.md Use this GitHub Action to validate changie fragments as part of your CI workflow. Ensure you use the latest version of the action and specify the desired changie version. The `args` parameter can be used to pass commands like `batch major --dry-run` for validation. ```yaml - name: Validate changie fragment is valid uses: miniscruff/changie-action@VERSION # view action repo for latest version with: version: latest # use the latest changie version # dry run may not be required as you likely aren't # committing the changes anyway, but it will print # to stdout this way args: batch major --dry-run ``` -------------------------------- ### Extract Kind Labels with YQ Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/yq.md This command retrieves the 'label' associated with each kind defined in the .changie.yaml configuration. ```sh yq '.kinds[].label' .changie.yaml ``` -------------------------------- ### Update Kind Configuration from String Array to Object Array Source: https://github.com/miniscruff/changie/blob/main/docs/guide/upgrade.md When upgrading from v0.5.0, the 'kinds' configuration has changed. Old string values should be replaced with objects containing a 'label' property. This ensures compatibility with the new configuration structure. ```yaml # Old kinds: - Added - Changed - Deprecated ``` ```yaml # New kinds: - label: Added - label: Changed - label: Deprecated ``` -------------------------------- ### Merge Batched Changes into Changelog Source: https://github.com/miniscruff/changie/blob/main/docs/guide/quick_start.md After batching a new version, use this command to merge the batched changes into your main changelog file. ```sh changie merge ``` -------------------------------- ### Enable Changelog Generation in GoReleaser Source: https://github.com/miniscruff/changie/blob/main/docs/integrations/goreleaser.md Ensure GoReleaser generates a changelog by setting `disable` to `false` in the `changelog` configuration. ```yaml changelog: disable: false ``` -------------------------------- ### Batch Unreleased Changes for Release Source: https://github.com/miniscruff/changie/blob/main/docs/guide/quick_start.md Batch all unreleased changes into one for the next release. Supports semver bump values, explicit versions, or auto-detection if kinds are configured. ```sh changie batch ``` ```sh changie batch ``` ```sh changie batch auto ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.