docs: Prepare the first tagged release - #1
Merged
Merged
Conversation
Nothing has ever been tagged here, so the pinning the README recommends resolves to nothing and every documented example fails. Records what the first release contains, and points the examples at a CLI version whose commands cover the whole agent API.
Code Review SummaryThis PR prepares the repo for v1.0.0 by adding a changelog and updating docs to use CLI v0.3.0. While the version updates are correct, the YAML indentation in the documentation is broken and needs to be fixed to ensure users can actually use the provided examples. 🚀 Key Improvements
💡 Minor Suggestions
🚨 Critical Issues
|
![sourceant[bot]](https://avatars.githubusercontent.com/in/1161781?s=60&v=4){kind=small}
|
|
||
| All notable changes to the FlatRun GitHub Actions are documented in this file. | ||
|
|
||
| ## [1.0.0] - 2026-08-11 |
There was a problem hiding this comment.
The release date '2026-08-11' appears to be a future-dated placeholder or a typo. It should be updated to the actual current date for the v1.0.0 release.
Suggested change
| ## [1.0.0] - 2026-08-11 | |
| +## [1.0.0] - 2024-05-22 |
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.
Nothing here has ever been tagged, so
@v1, which the README recommends and every example uses,resolves to nothing.
A changelog for the first release, and examples pinned to CLI 0.3.0 rather than 0.1.0.
Order: flatrun/cli#4, then the 0.3.0 tag, then this, then v1.0.0 and v1 here. Merged before the
release, the examples name a version nobody can download.