Skip to content

ci: remove deprecated actions and use stable #1193

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ci: remove deprecated actions and use stable #1193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f820290
ci: remove deprecated actions and use stable
joshka Jun 28, 2025
2bdb76e
ci: simplify cd.yml
joshka Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/run-fixtures-test/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ runs:
using: composite
steps:
- name: Install toolchain
uses: dtolnay/rust-toolchain@nightly
uses: dtolnay/rust-toolchain@stable

- name: Install git-cliff
run: cargo install --path git-cliff/ --profile dev
Expand Down
252 changes: 101 additions & 151 deletions .github/workflows/cd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,140 +26,93 @@ jobs:
publish-binaries:
name: Publish binaries
needs: generate-changelog
runs-on: ${{ matrix.build.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
build:
- {
NAME: linux-x64-glibc,
OS: ubuntu-22.04,
TOOLCHAIN: stable,
Copy link
Owner

@orhun orhun Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep this matrix variable? I think it would be useful if I want to use nightly for some reason in the future.

Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the change to use dtolnay/rust-toolchain, this variable is not used to do anything, so it makes the workflow confusing to have it specified. It's easy to add in the future if needed, but generally YAGNI.

If there is a per combination change that's used once though, a future change could instead do something like if: ${{ matrix.build.TOOLCHAIN != '' }} ... instead of repeating the toolchain for each item.

Copy link
Owner

@orhun orhun Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can still use it in dtolnay/rust-toolchain with an extra parameter AFAIK though.

Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but why? all the targets use stable. If you need to do something different, then add it then. Do you have an anticipated use case for where nightly might be necessary?

Copy link
Owner

@orhun orhun Jul 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, sometimes some deps magically do not work with stable Rust in the CI (it happened before).

It happens during the release so I'd prefer if we can do that now instead of hastily doing that after realizing the release is broken or something.

Sorry if I'm a bit pushy, I apparently have PTSD from one of the past releases lol

TARGET: x86_64-unknown-linux-gnu,
NPM_PUBLISH: true,
PYPI_PUBLISH: true,
}
- {
NAME: linux-x64-musl,
OS: ubuntu-22.04,
TOOLCHAIN: stable,
TARGET: x86_64-unknown-linux-musl,
NPM_PUBLISH: false,
PYPI_PUBLISH: true,
}
- {
NAME: linux-x86-glibc,
OS: ubuntu-22.04,
TOOLCHAIN: stable,
TARGET: i686-unknown-linux-gnu,
NPM_PUBLISH: false,
PYPI_PUBLISH: false,
}
- {
NAME: linux-x86-musl,
OS: ubuntu-22.04,
TOOLCHAIN: stable,
TARGET: i686-unknown-linux-musl,
NPM_PUBLISH: false,
PYPI_PUBLISH: true,
}
- {
NAME: linux-arm64-glibc,
OS: ubuntu-22.04,
TOOLCHAIN: stable,
TARGET: aarch64-unknown-linux-gnu,
NPM_PUBLISH: true,
PYPI_PUBLISH: true,
}
- {
NAME: linux-arm64-musl,
OS: ubuntu-22.04,
TOOLCHAIN: stable,
TARGET: aarch64-unknown-linux-musl,
NPM_PUBLISH: false,
PYPI_PUBLISH: true,
}
- {
NAME: win32-x64-mingw,
OS: windows-2022,
TOOLCHAIN: stable,
TARGET: x86_64-pc-windows-gnu,
NPM_PUBLISH: false,
PYPI_PUBLISH: false,
}
- {
NAME: win32-x64-msvc,
OS: windows-2022,
TOOLCHAIN: stable,
TARGET: x86_64-pc-windows-msvc,
NPM_PUBLISH: true,
PYPI_PUBLISH: true,
}
- {
NAME: win32-x86-msvc,
OS: windows-2022,
TOOLCHAIN: stable,
TARGET: i686-pc-windows-msvc,
NPM_PUBLISH: false,
PYPI_PUBLISH: true,
}
- {
NAME: win32-arm64-msvc,
OS: windows-2022,
TOOLCHAIN: stable,
TARGET: aarch64-pc-windows-msvc,
NPM_PUBLISH: true,
PYPI_PUBLISH: false,
}
- {
NAME: darwin-x64,
OS: macos-14,
TOOLCHAIN: stable,
TARGET: x86_64-apple-darwin,
NPM_PUBLISH: true,
PYPI_PUBLISH: true,
}
- {
NAME: darwin-arm64,
OS: macos-14,
TOOLCHAIN: stable,
TARGET: aarch64-apple-darwin,
NPM_PUBLISH: true,
PYPI_PUBLISH: true,
}
include:
Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrixinclude

- name: linux-x64-glibc
os: ubuntu-latest
target: x86_64-unknown-linux-gnu
publish_npm: true
publish_pypi: true
- name: linux-x64-musl
os: ubuntu-latest
target: x86_64-unknown-linux-musl
publish_npm: false
publish_pypi: true
install_musl: true
- name: linux-x86-glibc
os: ubuntu-latest
target: i686-unknown-linux-gnu
publish_npm: false
publish_pypi: false
- name: linux-x86-musl
os: ubuntu-latest
target: i686-unknown-linux-musl
publish_npm: false
publish_pypi: true
install_musl: true
- name: linux-arm64-glibc
Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#standard-github-hosted-runners-for-public-repositories for available runners

os: ubuntu-24.04-arm
target: aarch64-unknown-linux-gnu
publish_npm: true
publish_pypi: true
- name: linux-arm64-musl
os: ubuntu-24.04-arm
target: aarch64-unknown-linux-musl
publish_npm: false
publish_pypi: true
install_musl: true
- name: win32-x64-mingw
os: windows-latest
target: x86_64-pc-windows-gnu
publish_npm: false
publish_pypi: false
- name: win32-x64-msvc
os: windows-latest
target: x86_64-pc-windows-msvc
publish_npm: true
publish_pypi: true
- name: win32-x86-msvc
os: windows-latest
target: i686-pc-windows-msvc
publish_npm: false
publish_pypi: true
- name: win32-arm64-msvc
os: windows-11-arm
target: aarch64-pc-windows-msvc
publish_npm: true
publish_pypi: false
- name: darwin-x64
os: macos-13
target: x86_64-apple-darwin
publish_npm: true
publish_pypi: true
- name: darwin-arm64
os: macos-latest
target: aarch64-apple-darwin
publish_npm: true
publish_pypi: true
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set the release version
shell: bash
run: echo "RELEASE_VERSION=${GITHUB_REF:11}" >> $GITHUB_ENV
- name: Install dependencies
- name: Install Musl tools
if: matrix.install_musl
shell: bash
run: |
if [[ "${{ matrix.build.NAME }}" = *"-musl" ]]; then
sudo apt-get update
sudo apt-get install -y --no-install-recommends \
--allow-unauthenticated musl-tools
fi
sudo apt-get update
sudo apt-get install -y --no-install-recommends --allow-unauthenticated \
musl-tools
- name: Install Rust toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: ${{ matrix.build.TOOLCHAIN }}
target: ${{ matrix.build.TARGET }}
override: true
- name: Build (linux/macos)
if: matrix.build.OS != 'windows-2022'
uses: actions-rs/cargo@v1
with:
use-cross: true
command: build
args: --release --locked --target ${{ matrix.build.TARGET }}
Comment on lines -150 to -156
Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think cross is no longer necessary because the arm stuff is being built on the right runner now.

I'd suggest doing a quick check to validate this by turning off all the release parts of this change in another PR and just checking that all the build succeeds.

Copy link
Owner

@orhun orhun Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not so sure about not needing cross. This was extremely fragile to put together and testing it takes a lot of time.

Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the build commands run without cross, why would cross be needed?

Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checking this in #1198

Copy link
Owner

@orhun orhun Jul 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah I guess we can backport those changes from that PR

- name: Build (windows)
if: matrix.build.OS == 'windows-2022'
uses: actions-rs/cargo@v1
uses: dtolnay/rust-toolchain@stable
with:
command: build
args: --release --locked --target ${{ matrix.build.TARGET }} # --no-default-features
targets: ${{ matrix.target }}
- name: Build
run: cargo build --release --locked --target ${{ matrix.target }}
- name: Prepare release assets
shell: bash
run: |
Expand All @@ -168,122 +121,119 @@ jobs:
OUT_DIR=release/completions/ cargo run --release --bin git-cliff-completions
OUT_DIR=release/man/ cargo run --release --bin git-cliff-mangen
for bin in 'git-cliff' 'git-cliff-completions' 'git-cliff-mangen'; do
if [ "${{ matrix.build.OS }}" = "windows-2022" ]; then
if [ "${{ contains(matrix.os, 'windows') }}" = "true" ]; then
Comment on lines -171 to +124
Copy link
Contributor Author

@joshka joshka Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be further simplified and deduplicated by splitting the os and runner in the matrix above, either by adding a runner variable, or by adding an is_windows variable. I didn't worry about this as it's clear enough here.

There's possibly also a bash test that checks for true instead of string comparisonI but I haven't looked.

bin="${bin}.exe"
fi
cp "target/${{ matrix.build.TARGET }}/release/${bin}" release/
cp "target/${{ matrix.target }}/release/${bin}" release/
done
mv release/ git-cliff-${{ env.RELEASE_VERSION }}/
- name: Create release artifacts
shell: bash
run: |
if [ "${{ matrix.build.OS }}" = "windows-2022" ]; then
7z a -tzip "git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.zip" \
if [ "${{ contains(matrix.os, 'windows') }}" = "true" ]; then
7z a -tzip "git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.target }}.zip" \
git-cliff-${{ env.RELEASE_VERSION }}/
else
tar -czvf git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz \
tar -czvf git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz \
git-cliff-${{ env.RELEASE_VERSION }}/
shasum -a 512 git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz \
> git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz.sha512
shasum -a 512 git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz \
> git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz.sha512
fi
- name: Sign the release
if: matrix.build.OS == 'ubuntu-22.04' || matrix.build.OS == 'macos-14'
if: contains(matrix.os, 'ubuntu') || contains(matrix.os, 'macos')
run: |
echo "${{ secrets.GPG_RELEASE_KEY }}" | base64 --decode > private.key
echo "${{ secrets.GPG_PASSPHRASE }}" | gpg --pinentry-mode=loopback \
--passphrase-fd 0 --import private.key
echo "${{ secrets.GPG_PASSPHRASE }}" | gpg --pinentry-mode=loopback \
--passphrase-fd 0 --detach-sign \
git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz
git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz
- name: Publish to GitHub
if: ${{ !contains(github.ref, '-') }}
uses: svenstaro/upload-release-action@v2
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}*
file: git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.target }}*
file_glob: true
overwrite: true
tag: ${{ github.ref }}
release_name: "Release v${{ env.RELEASE_VERSION }}"
body: "${{ needs.generate-changelog.outputs.release_body }}"
- name: Publish to GitHub (pre-release)
if: ${{ contains(github.ref, '-') }}
if: contains(github.ref, '-')
uses: svenstaro/upload-release-action@v2
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}*
file: git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.target }}*
file_glob: true
overwrite: true
tag: ${{ github.ref }}
release_name: "Pre-release v${{ env.RELEASE_VERSION }}"
prerelease: true
- name: Install node
if: matrix.build.NPM_PUBLISH == true
if: matrix.publish_npm
uses: actions/setup-node@v4
with:
node-version: 18
registry-url: "https://registry.npmjs.org"
- name: Publish to NPM
if: matrix.build.NPM_PUBLISH == true
if: matrix.publish_npm
shell: bash
run: |
cd npm
bin="git-cliff"
node_os=$(echo "${{ matrix.build.NAME }}" | cut -d '-' -f1)
node_os=$(echo "${{ matrix.name }}" | cut -d '-' -f1)
export node_os
node_arch=$(echo "${{ matrix.build.NAME }}" | cut -d '-' -f2)
node_arch=$(echo "${{ matrix.name }}" | cut -d '-' -f2)
export node_arch
export version="${{ env.RELEASE_VERSION }}"
if [ "${{ matrix.build.OS }}" = "windows-2022" ]; then
if [ "${{ contains(matrix.os, 'windows') }}" = "true" ]; then
export node_pkg="${bin}-windows-${node_arch}"
else
export node_pkg="${bin}-${node_os}-${node_arch}"
fi
mkdir -p "${node_pkg}/bin"
envsubst < package.json.tmpl > "${node_pkg}/package.json"
if [ "${{ matrix.build.OS }}" = "windows-2022" ]; then
if [ "${{ contains(matrix.os, 'windows') }}" = "true" ]; then
bin="${bin}.exe"
fi
cp "../target/${{ matrix.build.TARGET }}/release/${bin}" "${node_pkg}/bin"
cp "../target/${{ matrix.target }}/release/${bin}" "${node_pkg}/bin"
cp ../README.md "${node_pkg}"
cd "${node_pkg}"
npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Build Python wheels (linux)
if: matrix.build.PYPI_PUBLISH == true && startsWith(matrix.build.NAME, 'linux')
if: matrix.publish_pypi && startsWith(matrix.name, 'linux')
uses: PyO3/maturin-action@v1
with:
working-directory: pypi
target: ${{ matrix.build.TARGET }}
target: ${{ matrix.target }}
args: --release --sdist --out wheels
sccache: "true"
# https://github.com/PyO3/maturin-action/issues/245
manylinux: ${{ matrix.build.TARGET == 'aarch64-unknown-linux-gnu' && '2_28' || 'auto' }}
manylinux: ${{ matrix.target == 'aarch64-unknown-linux-gnu' && '2_28' || 'auto' }}
- name: Build Python wheels (macos & windows)
if: |
matrix.build.PYPI_PUBLISH == true &&
(startsWith(matrix.build.OS, 'macos') || startsWith(matrix.build.OS, 'windows'))
if: matrix.publish_pypi && (contains(matrix.os, 'macos') || contains(matrix.os, 'windows'))
uses: PyO3/maturin-action@v1
with:
working-directory: pypi
target: ${{ matrix.build.TARGET }}
target: ${{ matrix.target }}
args: --release --sdist --out wheels
sccache: "true"
- name: Build Python wheels (musl)
if: matrix.build.PYPI_PUBLISH == true && endsWith(matrix.build.OS, 'musl')
if: matrix.publish_pypi && matrix.install_musl
uses: PyO3/maturin-action@v1
with:
working-directory: pypi
target: ${{ matrix.build.TARGET }}
target: ${{ matrix.target }}
args: --release --sdist --out wheels
sccache: "true"
manylinux: musllinux_1_2
- name: Upload Python wheels
uses: actions/upload-artifact@v4
with:
name: "wheels-${{ matrix.build.TARGET }}"
working-directory: pypi
name: "wheels-${{ matrix.target }}"
path: pypi/wheels

publish-npm:
Expand Down
Loading
Loading