Repository navigation
Develop #319
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.
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
Merged
Develop #319
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,45 @@ | ||
| # GitHub Copilot Guidance | ||
|
|
||
| ## Purpose | ||
|
|
||
| This file summarizes the solution and defines the hierarchy of guidance for AI-assisted contributions. | ||
|
|
||
| ## Guidance Hierarchy (Must Follow) | ||
|
|
||
| 1. [CODESTYLE.md](../CODESTYLE.md) is the master code style and formatting authority. | ||
| 2. [AGENTS.md](../AGENTS.md) is secondary guidance describing the solution, workflows, and conventions. | ||
| 3. Repository configuration files such as [`.editorconfig`](../.editorconfig) and [`.vscode/tasks.json`](../.vscode/tasks.json) define enforced formatting, line endings, and task expectations. | ||
|
|
||
| If any instruction conflicts, follow CODESTYLE.md first, then AGENTS.md. | ||
|
|
||
| ## Solution Summary | ||
|
|
||
| This repository builds and publishes Docker images for Network Optix VMS products (Nx Witness, Nx Meta, Nx Go, DW Spectrum, Wisenet WAVE). It includes a .NET tooling project that generates Dockerfiles, matrices, and version inputs used by CI and packaging scripts. | ||
|
|
||
| ### Core Projects | ||
|
|
||
| - `CreateMatrix` (.NET 10 console app): Generates Dockerfiles and build matrix data using version and release metadata. | ||
| - `CreateMatrixTests` (xUnit v3 + AwesomeAssertions): Validates release handling and version forwarding. | ||
|
|
||
| ### Key Inputs and Outputs | ||
|
|
||
| - Inputs: version and matrix data in `version.json`, [Make/Version.json](../Make/Version.json), and [Make/Matrix.json](../Make/Matrix.json). | ||
| - Outputs: Dockerfiles in [Docker/](../Docker/) and compose/test artifacts in [Make/](../Make/). | ||
| - Templates: Unraid container templates in [Unraid/](../Unraid/). | ||
|
|
||
| ### Build and Validation Workflow (High Level) | ||
|
|
||
| - Primary entry points are the `CreateMatrix` CLI commands (version, matrix, make) run directly or via scripts in [Make/](../Make/). | ||
| - Formatting and style verification are enforced by CSharpier and dotnet format, with Husky.Net hooks. | ||
| - The `.Net Format` VS Code task in [`.vscode/tasks.json`](../.vscode/tasks.json) must be clean and warning-free at all times. | ||
|
|
||
| ## What to Keep in Sync | ||
|
|
||
| - Generated Dockerfiles and scripts must reflect CreateMatrix behavior. | ||
| - Documentation in [README.md](../README.md) and release notes should align with current outputs and supported product variants. | ||
|
|
||
| ## Expectations for Changes | ||
|
|
||
| - Follow the zero-warnings policy and formatting requirements in [CODESTYLE.md](../CODESTYLE.md). | ||
| - Use explicit types (no `var`), Allman braces, file-scoped namespaces, and other conventions as defined in the master style guide. | ||
| - Respect line endings and encoding rules from the repository configuration, including UTF-8 without BOM. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -75,6 +75,7 @@ | |
| "ssdpool", | ||
| "subvol", | ||
| "subvolid", | ||
| "tagsargs", | ||
| "TARGETARCH", | ||
| "TARGETPLATFORM", | ||
| "tmpfs", | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.