-
Notifications
You must be signed in to change notification settings - Fork 0
chore: update repository to comply with standards #123
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
Malcolmnixon
merged 5 commits into
main
from
copilot/update-repository-to-comply-with-standards
Apr 3, 2026
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7c2d7cb
chore: update repository to comply with standards
Copilot bbe6fb1
chore: remove OTS review from reviewmark
Copilot e02d6b7
chore: fix trailing blank line in reviewmark.yaml
Copilot cb1f6ff
Update docs/design/system.md
Malcolmnixon 13fa03d
docs: update target framework to include .NET 10
Copilot 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
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 |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # BuildMark System Design | ||
|
|
||
| ## Overview | ||
|
|
||
| BuildMark is a .NET command-line tool that generates markdown build notes from | ||
| GitHub repository metadata. It queries GitHub's GraphQL API to retrieve commits, | ||
| issues, pull requests, and version tags, then formats the results as a structured | ||
| markdown report suitable for embedding in release documentation. | ||
|
|
||
| ## System Architecture | ||
|
|
||
| BuildMark is composed of four subsystems and a top-level entry point: | ||
|
|
||
| | Component | Kind | Responsibility | | ||
| |----------------------|-----------|----------------------------------------------------------| | ||
| | `Program` | Unit | Entry point; dispatches to handlers based on CLI flags | | ||
| | `Cli` | Subsystem | Command-line argument parsing and output channel control | | ||
| | `RepoConnectors` | Subsystem | Repository metadata retrieval via the GitHub GraphQL API | | ||
| | `SelfTest` | Subsystem | Built-in self-validation test framework | | ||
| | `Utilities` | Subsystem | Shared path combination helpers | | ||
|
|
||
| ## External Interfaces | ||
|
|
||
| | Interface | Direction | Protocol / Format | | ||
| |-----------------|-----------|-----------------------------------------------------| | ||
| | Command line | Input | POSIX-style flags parsed by `Context` | | ||
| | GitHub GraphQL | Output | HTTPS POST to `https://api.github.com/graphql` | | ||
| | Markdown report | Output | File written to `--report` path, UTF-8 markdown | | ||
| | Log file | Output | Optional file written to `--log` path, plain text | | ||
| | Test results | Output | TRX or JUnit XML written to `--results` path | | ||
| | Exit code | Output | 0 = success, 1 = error | | ||
|
|
||
| ## Data Flow | ||
|
|
||
| ```text | ||
| [Command Line Args] | ||
| │ | ||
| ▼ | ||
| Context (Cli) ← parses flags, opens log/report files | ||
| │ | ||
| ▼ | ||
| Program.Run() | ||
| ├─ --version → writes version to stdout | ||
| ├─ --help → writes usage to stdout | ||
| ├─ --validate → Validation (SelfTest) → writes results to --results file | ||
| └─ (default) → ProcessBuildNotes() | ||
| │ | ||
| ▼ | ||
| RepoConnectorFactory | ||
| │ | ||
| ▼ | ||
| GitHubRepoConnector ←─── GitHub GraphQL API | ||
| │ | ||
| ▼ | ||
| BuildInformation.ToMarkdown() | ||
| │ | ||
| ▼ | ||
| [Markdown Report File] | ||
| ``` | ||
|
|
||
| ## System-Wide Design Constraints | ||
|
|
||
| - **Target framework**: .NET 8 and .NET 9 | ||
|
Malcolmnixon marked this conversation as resolved.
Outdated
|
||
| - **Platform support**: Windows, Linux, macOS | ||
| - **Packaging**: Published as a .NET global tool (`dotnet tool install`) | ||
| - **Authentication**: GitHub token supplied via `GH_TOKEN` environment variable, | ||
| `GITHUB_TOKEN` environment variable, or `gh auth token` CLI fallback | ||
| - **No GUI**: All interaction is through the command line; no interactive prompts | ||
| - **Self-contained**: No external configuration files required for normal operation | ||
|
|
||
| ## Integration Patterns | ||
|
|
||
| ### GitHub GraphQL Client | ||
|
|
||
| `GitHubRepoConnector` uses `GitHubGraphQLClient` to issue paginated GraphQL | ||
| queries over HTTPS. Authentication is via `Authorization: bearer <token>` header. | ||
| The connector retrieves: | ||
|
|
||
| - All tags (for identifying version boundaries) | ||
| - Commits in the requested range | ||
| - Issues referenced by commits | ||
| - Pull requests in the requested range | ||
| - Releases (for known-issues data) | ||
|
|
||
| ### Self-Validation | ||
|
|
||
| The `--validate` flag invokes `Validation.Run`, which exercises core tool | ||
| functionality using a `MockRepoConnector` and writes a standard TRX or JUnit XML | ||
| results file. This allows operators to verify the tool works correctly in their | ||
| environment without requiring a live GitHub connection. | ||
|
|
||
| ### Report Generation | ||
|
|
||
| `BuildInformation.ToMarkdown` converts the in-memory build data model into a | ||
| markdown string. The heading depth is configurable via `--report-depth`, allowing | ||
| the report to be embedded at any level in a larger document. | ||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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,19 +1,19 @@ | ||
| --- | ||
| includes: | ||
| - docs/reqstream/buildmark-system.yaml | ||
| - docs/reqstream/system.yaml | ||
| - docs/reqstream/platform-requirements.yaml | ||
| - docs/reqstream/unit-program.yaml | ||
| - docs/reqstream/cli/subsystem-cli.yaml | ||
| - docs/reqstream/cli/unit-context.yaml | ||
| - docs/reqstream/self-test/subsystem-self-test.yaml | ||
| - docs/reqstream/self-test/unit-validation.yaml | ||
| - docs/reqstream/utilities/subsystem-utilities.yaml | ||
| - docs/reqstream/utilities/unit-path-helpers.yaml | ||
| - docs/reqstream/repo-connectors/subsystem-repo-connectors.yaml | ||
| - docs/reqstream/repo-connectors/unit-github-repo-connector.yaml | ||
| - docs/reqstream/ots-mstest.yaml | ||
| - docs/reqstream/ots-reqstream.yaml | ||
| - docs/reqstream/ots-buildmark.yaml | ||
| - docs/reqstream/ots-versionmark.yaml | ||
| - docs/reqstream/ots-sarifmark.yaml | ||
| - docs/reqstream/ots-sonarmark.yaml | ||
| - docs/reqstream/program.yaml | ||
| - docs/reqstream/cli/cli.yaml | ||
| - docs/reqstream/cli/context.yaml | ||
| - docs/reqstream/self-test/self-test.yaml | ||
| - docs/reqstream/self-test/validation.yaml | ||
| - docs/reqstream/utilities/utilities.yaml | ||
| - docs/reqstream/utilities/path-helpers.yaml | ||
| - docs/reqstream/repo-connectors/repo-connectors.yaml | ||
| - docs/reqstream/repo-connectors/github-repo-connector.yaml | ||
| - docs/reqstream/ots/mstest.yaml | ||
| - docs/reqstream/ots/reqstream.yaml | ||
| - docs/reqstream/ots/buildmark.yaml | ||
| - docs/reqstream/ots/versionmark.yaml | ||
| - docs/reqstream/ots/sarifmark.yaml | ||
| - docs/reqstream/ots/sonarmark.yaml |
Oops, something went wrong.
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.