Skip to content

docs: add logo, badges, and CodeQL security workflow - #11

Merged
srbouffard merged 2 commits into
mainfrom
docs/logo-badges-security
Jun 17, 2026
Merged

docs: add logo, badges, and CodeQL security workflow#11
srbouffard merged 2 commits into
mainfrom
docs/logo-badges-security

Conversation

@srbouffard

Copy link
Copy Markdown
Owner

Changes

Logo

Adds assets/arok_logo.png and displays it centered above the README title (360px wide — legible but not overwhelming).

Badges

Five badges in a centered row beneath the logo:

  • Release — links to latest GitHub release
  • CI — live status of the ci.yml workflow on main
  • CodeQL — live status of the new security scan
  • Go version — static 1.26+ badge
  • License — MIT

CodeQL workflow (.github/workflows/codeql.yml)

  • Runs on push/PR to main and on a weekly Monday schedule
  • Uses security-and-quality query suite for Go
  • Findings surface as GitHub Security Advisories / code scanning alerts

- Add assets/arok_logo.png (centered in README header)
- Add badges: release, CI, CodeQL, Go version, MIT license
- Add .github/workflows/codeql.yml: Go CodeQL analysis on push/PR/weekly

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@srbouffard
srbouffard merged commit 4908900 into main Jun 17, 2026
5 checks passed
@srbouffard
srbouffard deleted the docs/logo-badges-security branch June 17, 2026 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants