Skip to content

Commit 394c93c

Browse files
committed
docs/ci: README Quality & Security; add CodeQL; add .clang-format; add PRERELEASE (optional build.yml upgrade)
1 parent 7163240 commit 394c93c

File tree

4 files changed

+9
-19
lines changed

4 files changed

+9
-19
lines changed

,clang-format

Lines changed: 0 additions & 7 deletions
This file was deleted.

.github/workflows/build.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ jobs:
2828
if: runner.os == 'Windows'
2929
run: choco install ninja --no-progress
3030

31-
# macOS generally has cmake; ensure zip is present
3231
- name: Ensure zip (macOS)
3332
if: runner.os == 'macOS'
3433
run: |
@@ -99,4 +98,4 @@ jobs:
9998
- name: Create GitHub Release
10099
uses: softprops/action-gh-release@v2
101100
with:
102-
files: artifacts/**/*
101+
files: artifacts/**/*

PRERELEASE.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ _Date: 2025-09-23_
55
66
## Summary
77
This pre-release focuses on developer experience and packaging:
8-
- Convenience PowerShell tooling under `tools/` (`build.ps1`, `pack.ps1`, `install.ps1`, `uninstall.ps1`, `make.ps1`).
8+
- PowerShell tooling under `tools/` (`build.ps1`, `pack.ps1`, `install.ps1`, `uninstall.ps1`, `make.ps1`).
99
- Visual Studio builds in a separate `build-vs` folder.
10-
- CI now uploads **raw binaries and zipped artefacts** per OS.
11-
- Repository hygiene and docs: updated README, CHANGELOG, CONTRIBUTING, SECURITY, issue templates.
10+
- CI uploads **raw binaries and zipped artefacts** per OS.
11+
- Repository hygiene and docs: updated README, CONTRIBUTING, SECURITY, issue templates.
1212
- Optional style guard via `.clang-format` (LLVM base).
1313

1414
## Highlights
@@ -65,11 +65,9 @@ powershell -ExecutionPolicy Bypass -File .\tools\pack.ps1 -InstallToUserBin
6565
```
6666

6767
## Checksums
68-
The CI job will attach `.zip` artefacts. Compute checksums locally (example on Windows PowerShell):
68+
Compute checksums locally (example on Windows PowerShell):
6969
```powershell
7070
Get-FileHash .\dist\uaengine-windows.zip -Algorithm SHA256
7171
```
7272

73-
---
74-
7573
Thanks for testing! Please file issues with logs and your OS/compiler details.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,14 +204,14 @@ Artifacts are uploaded per job. On tag pushes, a GitHub Release is created and a
204204

205205
Workflow file: `.github/workflows/build.yml`.
206206

207-
> Tip: If you want zipped artifacts with neat names (`uaengine-windows.zip`, etc.), add a final “zip + upload” step in the workflow.
208-
209-
---
210207
### Quality & Security
211208
- **Code scanning:** This repo runs **CodeQL** on pushes, PRs, and weekly. See the *CodeQL* workflow in Actions.
212-
- **Formatting:** We ship a `.clang-format` (LLVM base, 2space indents, Allman). To format locally:
209+
- **Formatting:** We ship a `.clang-format` (LLVM base, 2-space indents, Allman). To format locally:
213210
- **Windows (if installed):** `clang-format -i $(git ls-files *.c *.h)` (PowerShell may need a loop)
214211
- **Linux/macOS:** `git ls-files '*.c' '*.h' | xargs clang-format -i`
212+
213+
---
214+
215215
## Versioning & Releases
216216

217217
- The CLI reports its version via `--version` (string lives in `include/ueng/version.h`).

0 commit comments

Comments
 (0)