diff --git a/.github/release.yaml b/.github/release.yaml new file mode 100644 index 0000000..129db83 --- /dev/null +++ b/.github/release.yaml @@ -0,0 +1,22 @@ +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +changelog: + categories: + - title: Noteworthy Changes :scroll: + labels: + - '*' + exclude: + authors: + - dependabot diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 32d0a86..f90e361 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -99,15 +99,19 @@ jobs: files: artifacts/files/* fail_on_unmatched_files: true generate_release_notes: true + append_body: true body: | - Download the version below matching your computer's OS and - processor architecture. + Download the version below matching your computer's OS and \ + processor architecture. Rename the file to `adifmt` or \ + `adifmt.exe`, make it executable with `chmod a+x adifmt`, and put \ + it somewhere in your `PATH` environment like `~/bin/`. Verify it \ + was installed by running `adifmt version`. - * macOS users: Download `adifmt-darwin-arm64` for Macs with M1 chips - or newer. Download `adifmt-darwin-amd64` for older Macs. - * Windows users: Download `adifmt-windows-amd64` for most modern - PCs, `adifmt-windows-arm64` for tablets and other ARM devices, and - `adifmt-windows-386` for older 32-bit computers. - * Linux users: Download `adifmt-linux-arm64` or `adifmt-linux-arm` - for Raspberry Pi or other embedded/mobile devices. Otherwise, + * macOS users: Download `adifmt-darwin-arm64` for Macs with M1 \ + chips or newer. Download `adifmt-darwin-amd64` for older Macs. + * Windows users: Download `adifmt-windows-amd64` for most modern \ + PCs, `adifmt-windows-arm64` for tablets and other ARM devices, \ + and `adifmt-windows-386` for older 32-bit computers. + * Linux users: Download `adifmt-linux-arm64` or `adifmt-linux-arm` \ + for Raspberry Pi or other embedded/mobile devices. Otherwise, \ download `adifmt-linux-amd64` (64-bit) or `adifmt-linux-386) (32).