(6.2.1) Write Quickstart Guide for shared-actions#291
Draft
leynos wants to merge 17 commits into
Draft
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
…7, MD004) - Fix MD013 line length violations by wrapping long lines to 80 chars - Fix MD060 table formatting by using '---' separators and proper spacing - Fix MD012 multiple blank lines by consolidating to single blank lines - Fix MD032 blank lines around lists by adding proper spacing - Fix MD047 trailing newline by ensuring files end with single newline - Fix MD004 list style by changing asterisks to dashes Changes made to: - .github/actions/*/README.md files (table formatting and line length) - docs/windows-gnullvm-build.md (wrapped long lines) - docs/execplans/*.md (blank lines, list spacing, long lines) - docs/adr/0001-stable-manpage-path.md (list style) - docs/cmd-mox-users-guide.md (line wrapping) - rust-toy-app/README.md (table formatting and line length) - README.md (table alignment) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Minor reformatting of release-to-pypi-uv/README.md table descriptions to comply with MD013 line length constraints while maintaining meaning. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Shorten table descriptions to meet 80-character line limit. Reformat long tables for better readability. Fix code block line wrapping in scripting-standards.md. Simplify composite-actions-vs-full-workflows table. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Reduce line lengths in determine-release-modes, ensure-cargo-version, and windows-package action READMEs to comply with 80-character limit. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Shorten crate-version description to meet 80-character limit. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Fixes all remaining markdown linting errors including: - Removed consecutive blank lines (MD012) - Wrapped long lines to 80 characters (MD013) - Added proper spacing around fenced code blocks (MD031) - Added language specifiers to code blocks (MD040) - Fixed lists surrounded by blank lines (MD032) - Changed emphasis to proper heading (MD036) - Removed trailing spaces (MD009) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Added blank lines around lists and numbered lists as required by MD032 rule. All markdown linting checks now pass. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
- Break long lines to ≤80 characters - Add language specifications to code blocks - Fix heading hierarchy and duplicates - Ensure proper blank lines around lists and code blocks - Convert emphasis-based status to proper heading All MD013, MD012, MD031, MD032, MD036, MD001, MD024, MD040 violations resolved.
Renamed duplicate section headings (Steps, Go/no-go gate) to include phase numbers (Phase 1 Steps, Phase 1 Go/no-go gate, etc.) to resolve MD024 violations. Also fixed MD001 heading increment violations by converting incorrectly nested headings to bold text where appropriate. All markdown linting checks now pass. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
leynos
force-pushed
the
6-2-1-write-quickstart-guide
branch
from
b09b16e to
1beac5f
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Proposes design for supporting multiple names per configuration parameter with compile-time and runtime alias registration. Includes motivation from vk and podbot use cases, detailed design with macro-level expansion, runtime API, precedence rules, comprehensive testing strategy, migration path, and consideration of alternatives (raw scanning, separate layers, config files). Addresses unresolved questions around case sensitivity, deprecation tracking, nested struct handling, and performance profiling. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Multi-agent research and community review incorporated: Prior Art Research: - Analyzed 9 tools (clap, config-rs, Viper, envy, figment, pydantic-settings) - Identified existing patterns in Rust, Go, Python config ecosystems Technical Review Findings: - 10 strengths: intuitive macro syntax, clear precedence rules, comprehensive test strategy, thorough alternatives analysis - 13 concerns addressed: runtime vs compile-time precedence, nested struct composition, transitive alias handling, performance implications Security Review: - 16 risks identified: credential leakage, redaction in error messages, cycle detection, sensitive field marking, audit logging requirements - 14 mitigations: add sensitive metadata, implement redaction, support immutable aliases mode, restrict runtime scope, enforce deprecation Design Highlights: - Three-layer architecture: compile-time macros, runtime builder API, auto-generated documentation with secret redaction - Real use cases grounded in vk (GitHub token) and podbot (multi-environment) - Phased migration strategy with backwards compatibility - Unresolved questions explicitly marked for follow-up RFCs Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
- Wrap long lines to 80 character limit - Add blank lines around lists - Fix table formatting with proper column alignment - Add language specifications to code blocks - Wrap long reference links - Remove trailing whitespace Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
- Fixed table alignment (MD060): aligned pipe characters with header - Added language specifier to fenced code block (MD040): rust - Added blank lines around code blocks in lists (MD031) - Shortened long lines and replaced en-dashes (MD013): adjusted reference links to fit within 80-character line limit All lint checks now pass: markdownlint and nixie validation complete. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
…esolution Policy Proposes adding a generic file-layer resolution policy API to ortho-config, enabling complex discovery patterns (ordered explicit selectors, multi-scope stacking, fail-closed semantics) without duplicating logic in applications. Key features: - Ordered explicit selector chain (CLI, env vars, aliases) with required/ exclusive semantics - Multi-scope automatic discovery (system/user/project) with scope ordering - Reusable file-layer resolver for early diagnostic access and late merge - Extended discovery(...) macro attributes - Explicit error policy distinguishing selected/automatic/malformed files Targets netsuke as primary use case; eliminates need for custom config-goblin logic in src/cli/discovery.rs. Separates ortho-config mechanics from application policy choices. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
The file-layer policy RFC was generated during multi-agent research but is outside the scope of the requested environment variable aliases RFC. Removing to keep deliverables focused on the requested design. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR introduces a comprehensive quickstart guide for the shared-actions repository to help new users discover, understand, and use the available GitHub Actions.
Key deliverables:
docs/quickstart.mdwith scenario-driven onboardingWhat this solves:
New users previously faced a steep learning curve with only a bare README table. This guide provides narrative context, working examples, and a decision tree to help users quickly find relevant actions and compose them into working workflows.
Scope & Constraints:
docs/execplans/6-2-1-write-quickstart-guide.mdExecplan
See
docs/execplans/6-2-1-write-quickstart-guide.mdfor the full execution plan including:References
ExecPlan Document:
docs/execplans/6-2-1-write-quickstart-guide.mdRelated Roadmap Item: 6. Documentation and release → 6.2. User guide and examples → 6.2.1. Write quickstart guide
Note: LODY_SESSION_ID was not available in the environment at the time of PR update.