Skip to content

Commit deb4245

Browse files
evanwilson-archevanwilson-arch
authored
Merge pull request #1 from evanwilson-arch/chore/repository-standardization-12037004920627078144
Standardize Repository Infrastructure and Automation
2 parents 0564862 + 0f50751 commit deb4245

8 files changed

Lines changed: 308 additions & 16 deletions

File tree

‎.github/workflows/checksums.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Release Assets
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
checksums:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Download Assets
17+
env:
18+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+
run: |
20+
# Download all assets for the release that triggered the workflow
21+
gh release download "${{ github.event.release.tag_name }}" --dir ./assets
22+
23+
- name: Generate Checksums
24+
run: |
25+
cd assets
26+
# Generate SHA-256 hashes for all downloaded files, excluding any existing checksums.txt
27+
sha256sum * > ../checksums.txt
28+
29+
- name: Upload Checksums to Release
30+
env:
31+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32+
run: |
33+
gh release upload "${{ github.event.release.tag_name }}" checksums.txt --clobber

‎.github/workflows/lychee.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Link Checker
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
schedule:
9+
- cron: "0 0 * * 1" # Run weekly on Monday at midnight
10+
11+
jobs:
12+
lychee:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- name: Link Checker
17+
uses: lycheeverse/lychee-action@v1.9.3
18+
with:
19+
args: --verbose --no-progress "**/*.md"
20+
env:
21+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/markdownlint.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Documentation Linter
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
markdownlint:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Run markdownlint
15+
uses: DavidAnson/markdownlint-cli2-action@v16
16+
with:
17+
globs: "**/*.md"

‎.github/workflows/release-please.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: release-please
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
release-please:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: google-github-actions/release-please-action@v4
17+
with:
18+
release-type: simple

‎CODE_OF_CONDUCT.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **security@milehighworldllc.com**. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to CodeQL CLI Binaries
2+
3+
Thank you for your interest in contributing to the CodeQL CLI distribution infrastructure for MILEHIGH-WORLD LLC. To maintain enterprise-grade resilience and ensure seamless automation via agentic workflows, we enforce strict contribution protocols.
4+
5+
## Commit Message Format
6+
7+
We strictly enforce **Conventional Commits**. This is non-negotiable as it powers our automated release versioning via `release-please`.
8+
9+
The format is:
10+
`<type>(<scope>): <description>`
11+
12+
Common types:
13+
- `feat`: A new feature (corresponds to a MINOR version bump)
14+
- `fix`: A bug fix (corresponds to a PATCH version bump)
15+
- `docs`: Documentation only changes
16+
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, etc)
17+
- `refactor`: A code change that neither fixes a bug nor adds a feature
18+
- `perf`: A code change that improves performance
19+
- `test`: Adding missing tests or correcting existing tests
20+
- `chore`: Changes to the build process or auxiliary tools and libraries
21+
22+
Example:
23+
`feat(automation): add markdownlint workflow`
24+
25+
## Branching Strategy
26+
27+
To isolate work and track automated workflows, please use the following prefixes for your branches:
28+
29+
- `feature/<ticket-or-name>`: Standard development and new features.
30+
- `hotfix/<issue>`: Production-critical patches.
31+
- `agent/<tool-name>`: AI-driven workflows and agentic tool updates (e.g., `agent/jules`).
32+
33+
## Pull Request Process
34+
35+
1. Create a branch from `main` using the appropriate prefix.
36+
2. Ensure your commit messages follow the Conventional Commits standard.
37+
3. Documentation changes must pass the `markdownlint` and `lychee` checks in CI.
38+
4. Once your changes are ready, open a Pull Request.
39+
5. All PRs require review and approval before merging.
40+
6. Upon merging to `main`, the `release-please` workflow will automatically manage versioning and changelog updates.

‎README.md‎

Lines changed: 69 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,78 @@
1-
# CodeQL CLI
1+
# CodeQL CLI Binaries
22

3-
This repo holds binaries for the CodeQL CLI.
3+
This repository serves as the official distribution hub for CodeQL CLI binaries used within the **Into the Void** development ecosystem and **MILEHIGH-WORLD LLC**'s enterprise infrastructure.
44

5-
[CodeQL overview](https://securitylab.github.com/tools/codeql/) | [CodeQL CLI Documentation](https://codeql.github.com/docs/codeql-cli/)
5+
## Architectural Overview
66

7-
# Getting started
7+
The CodeQL CLI is a core component of our static analysis and delivery reliability strategy. It interfaces with our C# and Unity environments to provide deep semantic analysis of the codebase, ensuring artifact integrity and automated governance before deployment to PHNXENT production servers.
88

9-
1. Go to the [Releases page](https://github.com/github/codeql-cli-binaries/releases).
10-
2. Find the latest release, select Assets, and download the zip file containing the CLI.
11-
3. You'll also want to clone https://github.com/github/codeql to get the CodeQL queries and
12-
libraries. Please take note of the
13-
[set-up instructions](https://codeql.github.com/docs/codeql-cli/getting-started-with-the-codeql-cli/)
14-
for placing it in a location where the CLI can find it.
15-
4. Read the rest of the [CodeQL CLI documentation](https://codeql.github.com/docs/codeql-cli/).
9+
By distributing binaries via GitHub Releases and providing cryptographic verification (SHA-256), we ensure a resilient and secure delivery pipeline for all internal and agentic workflows.
1610

17-
# Found a bug or have a question?
11+
## Getting Started
1812

19-
Please raise an issue in the [github/codeql](https://github.com/github/codeql/issues/new/choose) repository.
13+
### 1. Download & Verify
14+
1. Navigate to the [Releases page](https://github.com/github/codeql-cli-binaries/releases).
15+
2. Download the zip file corresponding to your operating system.
16+
3. Download the `checksums.txt` file from the same release.
17+
4. Verify the integrity of the binary (example for Linux/macOS):
18+
```bash
19+
sha256sum -c checksums.txt
20+
```
2021

21-
# License
22+
### 2. Setup
23+
To utilize CodeQL with our Unity projects, you must also clone the standard CodeQL queries:
24+
```bash
25+
git clone https://github.com/github/codeql
26+
```
27+
Follow the [setup instructions](https://codeql.github.com/docs/codeql-cli/getting-started-with-the-codeql-cli/) to place it where the CLI can find it.
2228

23-
By downloading, you agree to the [GitHub CodeQL Terms & Conditions](https://securitylab.github.com/tools/codeql/license/).
29+
## Integration Guide: Unity & C#
2430

25-
GitHub CodeQL can only be used on codebases that are released under an OSI-approved open source license, or to perform academic research. It can't be used to generate CodeQL databases for or during automated analysis, continuous integration or continuous delivery, whether as part of normal software engineering processes or otherwise. For these uses, [contact the sales team](https://enterprise.github.com/contact).
31+
CodeQL analysis of Unity projects requires capturing the C# compilation process. Standard text-based scanners are insufficient for our resilience requirements.
32+
33+
### Intercepting the Unity Build
34+
To build a semantic database of a Unity project, the GitHub Actions workflow must intercept the Unity batchmode build.
35+
36+
1. **Initialize the Database:**
37+
```bash
38+
codeql database init --language=csharp --source-root=./path/to/unity/project MyCodeQLDatabase
39+
```
40+
41+
2. **Execute Headless Unity Build:**
42+
Unity must be invoked in batchmode to trigger the C# compilation that CodeQL traces.
43+
```bash
44+
unity-editor -batchmode -nographics -projectPath ./path/to/unity/project -buildTarget Win64 -executeMethod MyBuildScript.PerformBuild -quit
45+
```
46+
*Note: Ensure your `MyBuildScript` uses standard `msbuild` or Unity's internal build pipeline to ensure all C# logic is compiled.*
47+
48+
3. **Finalize & Analyze:**
49+
```bash
50+
codeql database finalize MyCodeQLDatabase
51+
codeql database analyze MyCodeQLDatabase --format=sarif-latest --output=results.sarif
52+
```
53+
54+
## Troubleshooting
55+
56+
### "No source code found"
57+
This typically occurs when CodeQL fails to intercept any compilation events.
58+
- **Cause:** Unity might be using pre-compiled DLLs or a cache.
59+
- **Fix:** Perform a clean build. Delete the `Library` folder in the Unity project before running `codeql database init`.
60+
61+
### MSBuild Incompatibilities
62+
- **Issue:** Mismatched .NET SDK versions between the environment and Unity's expected runtime.
63+
- **Fix:** Explicitly set `FrameworkPathOverride` or use a specific MSBuild path via environment variables if the tracer fails to find the compiler.
64+
65+
### Agentic Workflow Failures
66+
If an agent (e.g., `agent/jules`) encounters failures:
67+
- Ensure the branch naming convention `agent/<tool-name>` is strictly followed to trigger the correct CI/CD runners.
68+
- Verify that `Conventional Commits` are used to prevent `release-please` from stalling.
69+
70+
## Governance & Security
71+
72+
- **Security Reporting:** Reports vulnerabilities to [security@milehighworldllc.com](mailto:security@milehighworldllc.com). See [SECURITY.md](SECURITY.md) for full protocol.
73+
- **Contribution:** We enforce a strict Conventional Commits policy. Refer to [CONTRIBUTING.md](CONTRIBUTING.md).
74+
- **Code of Conduct:** We adhere to the Contributor Covenant 2.1. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
75+
76+
## License
77+
78+
By downloading, you agree to the [GitHub CodeQL Terms & Conditions](LICENSE.md). Use is restricted to Open Source Codebases or for customers with a valid GitHub Advanced Security license.

‎SECURITY.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
MILEHIGH-WORLD LLC and the PHNXENT initiative take the security of our binary distribution infrastructure seriously. If you believe you have found a security vulnerability in the CodeQL CLI binaries or the distribution pipeline, please report it to us as follows:
6+
7+
1. **Do not open a GitHub Issue.** Public disclosure via GitHub Issues or any other public forum is strictly prohibited until the vulnerability has been patched and verified.
8+
2. Email your report to: **security@milehighworldllc.com**
9+
10+
Please include the following information in your report:
11+
- A detailed description of the vulnerability.
12+
- Steps to reproduce the issue.
13+
- Potential impact of the vulnerability.
14+
- Any suggested mitigations.
15+
16+
## Supported Versions
17+
18+
We only provide security updates for the latest released version of the CodeQL CLI binaries. Please ensure you are always using the most recent release.
19+
20+
## Response Process
21+
22+
After we receive your report:
23+
- We will acknowledge receipt within 48-72 hours.
24+
- We will perform a technical evaluation to confirm the vulnerability.
25+
- We will work on a fix and coordinate a release.
26+
- We will notify you once the fix is deployed.
27+
- We will credit you for the discovery (if desired) after the fix is publicly released.

0 commit comments

Comments
 (0)