Add comprehensive documentation for release commands #48
Conversation
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
Co-authored-by: greymag <[email protected]>
Copilot
AI
changed the title
[WIP] Describe commands from "release" section
Add comprehensive documentation for release commands
Aug 27, 2025
greymag
requested changes
Aug 27, 2025
README.md
Outdated
| - `--skip_l10n` (`-s`) - Skip localization process during release. | ||
| - `--local` (`-b`) - Run local release build for Android and iOS platforms. | ||
| - `--entry-point=<path>` (`-e`) - Entry point of the app (e.g., lib/main_test.dart). Only for local release builds. | ||
| - `--platforms=<PLATFORMS>` (`-p`) - Target build platforms: ios, android. You can pass multiple platforms separated by commas. Defaults to "android,ios". |
Contributor
There was a problem hiding this comment.
This is only for local builds too
Contributor
Author
There was a problem hiding this comment.
Added clarification that --platforms is "Only for local release builds" to make it clear when this option applies. (0983de2)
Contributor
|
@copilot make changes according to my comments |
Co-authored-by: greymag <[email protected]>
Contributor
Author
Made all the requested changes in the documentation:
All changes validated with static analysis and CLI functionality tests. (0983de2) |
greymag
approved these changes
Aug 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR addresses the TODO comment in the README.md file by adding complete documentation for the
alex releasecommand section.Changes Made
Documentation Added:
Command Options Documented:
--check_locale(-l) - Translation validation for specific locales--skip_l10n(-s) - Skip translations check during release--local(-b) - Run local release builds--entry-point(-e) - Custom app entry point for builds--platforms(-p) - Target build platforms (iOS/Android, only for local builds)Examples Provided:
alex release startalex release start --localThe documentation follows the existing README.md formatting style and structure, maintaining consistency with other command sections like Feature and l10n. Developer-specific options like
--demoare excluded to keep the documentation focused on end users.Validation
--demoflag to ensure they work correctlyFixes #47.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.