Repository navigation
README: remove beta install guide - #11
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the README documentation for this GitHub Action by removing the beta installation guidance and aligning usage examples to a versioned action reference.
Changes:
- Switch README examples from
ariga/setup-atlas@mastertoariga/setup-atlas@v0 - Remove the “beta” version installation example from the “Version” section
- Fix typos (“specifing” → “specifying”)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
4632ac5 to
f730ab9
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| If you want to install a specific driver flavor of Atlas, you can do so by specifying the `flavor` parameter. | ||
|
|
||
| ```yaml | ||
| - uses: ariga/setup-atlas@master | ||
| with: | ||
| flavor: "snowflake" | ||
| - uses: ariga/setup-atlas@v0 | ||
| with: | ||
| flavor: "snowflake" |
There was a problem hiding this comment.
The README describes flavor as selecting a specific driver flavor (e.g. "snowflake"), but the action implementation appears to only check whether inputs.flavor is non-empty and then prefixes the version with extended-, ignoring the actual flavor value. This makes the example and description misleading; either update the docs to describe the real behavior (e.g., "any non-empty value enables the extended build") or update the action to actually use the provided flavor value.
|
|
||
| ## Reporting Issues | ||
|
|
||
| If you encounter any issues or have feature requests, please file an issue on the [ariga/atlas](https://github.com/ariga/atlas/issues/new?labels=setup-atlas) repository with the `setup-atlas` tag. |
There was a problem hiding this comment.
This section says to file an issue with the setup-atlas "tag", but GitHub issues use labels (and your link sets labels=setup-atlas). Consider changing the wording to "label" to match the actual mechanism.
| If you encounter any issues or have feature requests, please file an issue on the [ariga/atlas](https://github.com/ariga/atlas/issues/new?labels=setup-atlas) repository with the `setup-atlas` tag. | |
| If you encounter any issues or have feature requests, please file an issue on the [ariga/atlas](https://github.com/ariga/atlas/issues/new?labels=setup-atlas) repository with the `setup-atlas` label. |
No description provided.