Skip to content

Commit a17e715

Browse files
2bndy52bndy5
committed
adjust CI
add openSSL to envs that don't ship with it. add workflow to build binaries (intended for release and nightly). fix git.rs unit tests don't let maturin CI fail fast use openssl-vendored feature for build envs that can't use native openssl
1 parent bdfac71 commit a17e715

File tree

8 files changed

+225
-29
lines changed

8 files changed

+225
-29
lines changed

‎.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@
88
*.sh text eol=lf
99
*.cpp text eol=lf
1010
*.hpp text eol=lf
11+
*.patch text eol=lf

‎.github/workflows/binary-builds.yml

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
name: Binary executable builds
2+
3+
permissions:
4+
contents: read
5+
6+
on:
7+
push:
8+
branches: [main]
9+
tags:
10+
- v[0-9]+.*
11+
pull_request:
12+
branches: [main]
13+
14+
env:
15+
CARGO_INCREMENTAL: 0
16+
CARGO_NET_GIT_FETCH_WITH_CLI: true
17+
CARGO_NET_RETRY: 10
18+
CARGO_TERM_COLOR: always
19+
RUST_BACKTRACE: 1
20+
RUSTFLAGS: -D warnings
21+
RUSTUP_MAX_RETRIES: 10
22+
23+
defaults:
24+
run:
25+
shell: bash
26+
27+
jobs:
28+
29+
create-assets:
30+
name: ${{ matrix.target }}
31+
strategy:
32+
fail-fast: false
33+
matrix:
34+
include:
35+
- target: aarch64-unknown-linux-gnu
36+
os: ubuntu-latest
37+
- target: aarch64-unknown-linux-musl
38+
os: ubuntu-latest
39+
- target: x86_64-unknown-linux-gnu
40+
os: ubuntu-latest
41+
- target: x86_64-unknown-linux-musl
42+
os: ubuntu-latest
43+
- target: aarch64-apple-darwin
44+
os: macos-latest
45+
- target: x86_64-apple-darwin
46+
os: macos-latest
47+
- target: x86_64-pc-windows-msvc
48+
os: windows-latest
49+
runs-on: ${{ matrix.os }}
50+
permissions:
51+
contents: write
52+
steps:
53+
- name: Calculate Release Version
54+
id: calc-version
55+
run: |
56+
if [ "${{ github.event_name }}" = "pull_request" ]; then
57+
short_sha=$(echo "${{ github.sha }}" | awk '{print substr($0,0,5)}')
58+
echo "RELEASE_VERSION=nightly-$(date '+%Y-%m-%d')-$short_sha" >> $GITHUB_OUTPUT
59+
else
60+
echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_OUTPUT
61+
fi
62+
63+
- name: Install Openssl on Linux
64+
if: runner.os == 'Linux' && !(startsWith(matrix.target, 'aarch64') || endsWith(matrix.target, 'musl'))
65+
run: sudo apt-get install -y openssl openssl-dev
66+
- name: Calculate openssl-vendored
67+
shell: bash
68+
id: is-openssl-vendored
69+
run: |
70+
case "${{ matrix.target }}" in
71+
"aarch64_apple_darwin" | "x86_64-apple-darwin" | "aarch64-unknown-linux-gnu" | "aarch64-unknown-linux-musl" | "x86_64-unknown-linux-musl")
72+
echo "enabled=true" >> $GITHUB_OUTPUT
73+
;;
74+
*)
75+
echo "enabled=false" >> $GITHUB_OUTPUT
76+
esac
77+
78+
- name: Checkout
79+
uses: actions/checkout@v4
80+
81+
- name: Setup Rust
82+
uses: dtolnay/rust-toolchain@stable
83+
with:
84+
target: ${{ matrix.target }}
85+
86+
- name: Build (openssl-vendored)
87+
if: steps.is-openssl-vendored.outputs.enabled == 'true'
88+
run: cargo build --release --target ${{ matrix.target }} --features openssl-vendored
89+
- name: Build (no openssl-vendored)
90+
if: steps.is-openssl-vendored.outputs.enabled == 'false'
91+
run: cargo build --release --target ${{ matrix.target }}
92+
93+
- name: Prepare artifacts [Windows]
94+
shell: bash
95+
if: matrix.os == 'windows-latest'
96+
id: prep-artifacts-windows
97+
run: |
98+
release_dir="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}"
99+
artifact_path="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}-${{ matrix.target }}.zip"
100+
echo "ARTIFACT_PATH=$artifact_path" >> $GITHUB_OUTPUT
101+
mkdir $release_dir
102+
cp target/${{ matrix.target }}/release/cpp-linter-cli.exe $release_dir/
103+
cp LICENSE $release_dir/
104+
7z a -tzip $artifact_path $release_dir/
105+
- name: Prepare artifacts [Unix]
106+
shell: bash
107+
id: prep-artifacts-unix
108+
if: matrix.os != 'windows-latest'
109+
run: |
110+
release_dir="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}"
111+
artifact_path="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz"
112+
echo "ARTIFACT_PATH=$artifact_path" >> $GITHUB_OUTPUT
113+
mkdir $release_dir
114+
cp target/${{ matrix.target }}/release/cpp-linter-cli $release_dir/
115+
cp LICENSE $release_dir
116+
tar -czvf $artifact_path $release_dir/
117+
- name: Upload artifacts
118+
uses: actions/upload-artifact@v4
119+
with:
120+
name: ${{ steps.prep-artifacts-unix.outputs.ARTIFACT_PATH || steps.prep-artifacts-windows.outputs.ARTIFACT_PATH }}
121+
path: ${{ steps.prep-artifacts-unix.outputs.ARTIFACT_PATH || steps.prep-artifacts-windows.outputs.ARTIFACT_PATH }}
122+
if-no-files-found: error
123+
124+
create-release:
125+
if: startswith(github.ref, 'refs/tags')
126+
runs-on: ubuntu-latest
127+
needs: [create-assets]
128+
permissions:
129+
contents: write
130+
steps:
131+
- uses: actions/checkout@v4
132+
with:
133+
persist-credentials: false
134+
- name: Install Rust
135+
run: rustup update stable --no-self-update
136+
- run: cargo package
137+
- name: Create a Github Release
138+
if: ${{ startsWith(github.ref, 'refs/tags/v') }}
139+
env:
140+
GH_TOKEN: ${{ github.token }}
141+
run: gh release create ${{ github.ref_name }} --generate-notes
142+
- run: cargo publish
143+
env:
144+
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
145+
146+
upload-assets:
147+
needs: [create-release]
148+
runs-on: ubuntu-latest
149+
strategy:
150+
matrix:
151+
include:
152+
- target: aarch64-unknown-linux-gnu
153+
- target: aarch64-unknown-linux-musl
154+
- target: x86_64-unknown-linux-gnu
155+
- target: x86_64-unknown-linux-musl
156+
- target: aarch64-apple-darwin
157+
- target: x86_64-apple-darwin
158+
- target: universal-apple-darwin
159+
- target: x86_64-pc-windows-msvc
160+
steps:
161+
- name: Download build asset
162+
uses: actions/download-artifact@v4
163+
with:
164+
name: cpp-linter-cli-${{ matrix.target }}
165+
path: dist
166+
- name: Upload release assets
167+
env:
168+
GH_TOKEN: ${{ github.token }}
169+
run: gh release upload ${{ github.ref_name }} dist/cpp-linter-cli${{ contains(matrix.target, 'windows') || '.exe' }}%#%cpp-linter-cli_${{ matrix.target }} --clobber

‎.github/workflows/python-packaging.yml

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
# This file is autogenerated by maturin v1.2.3
2-
# To update, run
3-
#
4-
# maturin generate-ci github
5-
#
61
name: Python packaging
72

83
on:
@@ -22,6 +17,7 @@ jobs:
2217
linux:
2318
runs-on: ubuntu-latest
2419
strategy:
20+
fail-fast: false
2521
matrix:
2622
target: [x86_64, x86, aarch64, armv7, s390x, ppc64le]
2723
steps:
@@ -34,17 +30,19 @@ jobs:
3430
with:
3531
target: ${{ matrix.target }}
3632
args: --release --out dist --find-interpreter
37-
sccache: 'true'
3833
manylinux: auto
34+
before-script-linux: |
35+
sudo apt-get install -y openssl openssl-dev
3936
- name: Upload wheels
4037
uses: actions/upload-artifact@v4
4138
with:
42-
name: wheels
43-
path: dist
39+
name: wheels-linux-${{ matrix.target }}
40+
path: dist/*
4441

4542
windows:
4643
runs-on: windows-latest
4744
strategy:
45+
fail-fast: false
4846
matrix:
4947
target: [x64, x86]
5048
steps:
@@ -58,34 +56,35 @@ jobs:
5856
with:
5957
target: ${{ matrix.target }}
6058
args: --release --out dist --find-interpreter
61-
sccache: 'true'
6259
- name: Upload wheels
6360
uses: actions/upload-artifact@v4
6461
with:
65-
name: wheels
66-
path: dist
62+
name: wheels-windows-${{ matrix.target }}
63+
path: dist/*
6764

6865
macos:
6966
runs-on: macos-latest
7067
strategy:
68+
fail-fast: false
7169
matrix:
7270
target: [x86_64, aarch64]
7371
steps:
7472
- uses: actions/checkout@v4
7573
- uses: actions/setup-python@v5
7674
with:
7775
python-version: '3.10'
76+
- name: Install OpenSSL (MacOS)
77+
run: brew install openssl@3
7878
- name: Build wheels
7979
uses: PyO3/maturin-action@v1
8080
with:
8181
target: ${{ matrix.target }}
82-
args: --release --out dist --find-interpreter
83-
sccache: 'true'
82+
args: --release --out dist --find-interpreter --features openssl-vendored
8483
- name: Upload wheels
8584
uses: actions/upload-artifact@v4
8685
with:
87-
name: wheels
88-
path: dist
86+
name: wheels-macos-${{ matrix.target }}
87+
path: dist/*
8988

9089
sdist:
9190
runs-on: ubuntu-latest
@@ -99,8 +98,8 @@ jobs:
9998
- name: Upload sdist
10099
uses: actions/upload-artifact@v4
101100
with:
102-
name: wheels
103-
path: dist
101+
name: wheels-sdist
102+
path: dist/*
104103

105104
release:
106105
name: Release
@@ -110,11 +109,11 @@ jobs:
110109
steps:
111110
- uses: actions/download-artifact@v4
112111
with:
113-
name: wheels
112+
path: dist
114113
- name: Publish to PyPI
115114
uses: PyO3/maturin-action@v1
116115
env:
117116
MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
118117
with:
119118
command: upload
120-
args: --non-interactive --skip-existing *
119+
args: --non-interactive --skip-existing dist/*

‎.github/workflows/run-dev-tests.yml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "Check python code"
1+
name: "Check rust code"
22

33
on:
44
push:
@@ -32,17 +32,22 @@ jobs:
3232

3333
- run: rustup component add llvm-tools-preview
3434

35+
# https://docs.rs/openssl/latest/openssl/#automatic
36+
- name: Install OpenSSL (Linux)
37+
if: runner.os == 'Linux'
38+
run: sudo apt-get install -y pkg-config libssl-dev
39+
- name: Install OpenSSL (MacOS)
40+
if: runner.os == 'macOS'
41+
run: brew install openssl@3
42+
# - name: Install OpenSSL (Windows)
43+
# if: runner.os == 'Windows'
44+
# run: vcpkg install openssl
45+
3546
- name: Install cargo-nextest and cargo-llvm-cov
3647
uses: taiki-e/install-action@v2
3748
with:
3849
tool: cargo-nextest,cargo-llvm-cov
3950

40-
- name: Restore build artifacts
41-
uses: actions/cache/restore@v3
42-
with:
43-
key: ${{ runner.os }}-${{ github.run_id }}_test_builds
44-
path: nextest-archive.tar.zst
45-
4651
- uses: actions/setup-python@v5
4752
with:
4853
python-version: 3.x

‎Cargo.toml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@ name = "cpp_linter"
99
crate-type = ["lib", "cdylib"]
1010

1111
[[bin]]
12-
name = "cpp-linter"
12+
name = "cpp-linter-cli"
1313
path = "src/bin.rs"
1414

1515
[dependencies]
1616
clap = { version = ">=4.4.2" }
1717
git2 = ">=0.18.1"
1818
lenient_semver = "0.4.2"
1919
log = ">=0.4.20"
20+
openssl = { version = "0.10", features = ["vendored"], optional = true }
21+
openssl-probe = { version = "0.1", optional = true }
2022
pyo3 = { version = ">=0.19.2", features = ["extension-module"] }
2123
regex = "1.10.2"
2224
reqwest = { version = "0.11", features = ["blocking", "json"] }
@@ -29,6 +31,9 @@ which = "5.0.0"
2931
[dev-dependencies]
3032
tempfile = "3.8.1"
3133

34+
[features]
35+
openssl-vendored = ["dep:openssl", "dep:openssl-probe"]
36+
3237
[package.metadata.scripts]
3338
run = "cargo run"
3439
check = "cargo check"

‎src/common_fs.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ use std::{fs, io};
66
use std::{ops::RangeInclusive, path::PathBuf};
77

88
/// A structure to represent a file's path and line changes.
9+
#[derive(Debug)]
910
pub struct FileObj {
1011
/// The path to the file.
1112
pub name: PathBuf,

‎src/git.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ rename to /tests/demo/some source.cpp
344344
#[cfg(test)]
345345
mod test {
346346
use std::{
347-
env::{current_dir, set_current_dir},
347+
env::{self, current_dir, set_current_dir},
348348
fs::read,
349349
};
350350

@@ -398,6 +398,7 @@ mod test {
398398
let rest_api_client = GithubApiClient::new();
399399
let (ignored, not_ignored) = parse_ignore(&["target"]);
400400
set_current_dir(tmp).unwrap();
401+
env::set_var("CI", "false"); // avoid use of REST API when testing in CI
401402
rest_api_client.get_list_of_changed_files(extensions, &ignored, &not_ignored)
402403
}
403404

@@ -409,6 +410,7 @@ mod test {
409410
let tmp = get_temp_dir();
410411
let extensions = vec!["cpp", "hpp"];
411412
let files = checkout_cpp_linter_py_repo(sha, &extensions, &tmp, None);
413+
println!("files = {:?}", files);
412414
assert!(files.is_empty());
413415
set_current_dir(cur_dir).unwrap(); // prep to delete temp_folder
414416
drop(tmp); // delete temp_folder
@@ -422,7 +424,8 @@ mod test {
422424
let tmp = get_temp_dir();
423425
let extensions = vec!["cpp", "hpp"];
424426
let files = checkout_cpp_linter_py_repo(sha, &extensions, &tmp, None);
425-
assert_eq!(files.len(), 2);
427+
println!("files = {:?}", files);
428+
assert!(files.len() >= 2);
426429
for file in files {
427430
assert!(extensions.contains(
428431
&file
@@ -451,6 +454,7 @@ mod test {
451454
&tmp,
452455
Some("tests/capture_tools_output/cpp-linter/cpp-linter/test_git_lib.patch"),
453456
);
457+
println!("files = {:?}", files);
454458
assert!(!files.is_empty());
455459
for file in files {
456460
assert!(extensions.contains(

0 commit comments

Comments
 (0)