Repository navigation
README: remove beta install guide #11
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -16,7 +16,7 @@ jobs: | |||||
| use-atlas: | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - uses: ariga/setup-atlas@master | ||||||
| - uses: ariga/setup-atlas@v0 | ||||||
| - run: atlas version | ||||||
| # - run: atlas schema apply ... | ||||||
| ``` | ||||||
|
|
@@ -25,41 +25,37 @@ jobs: | |||||
|
|
||||||
| ### Version | ||||||
|
|
||||||
| By default, the `latest` version of Atlas is being used. If you want to lock a specific version of Atlas, you can do so by specifing the `version` parameter. | ||||||
| By default, the `latest` version of Atlas is being used. If you want to lock a specific version of Atlas, you can do so by specifying the `version` parameter. | ||||||
|
|
||||||
| ```yaml | ||||||
| - uses: ariga/setup-atlas@master | ||||||
| with: | ||||||
| version: "vX.Y.Z" | ||||||
| ``` | ||||||
|
|
||||||
| If you want to install the beta version of Atlas, specify `beta` as the version: | ||||||
|
|
||||||
| ```yaml | ||||||
| - uses: ariga/setup-atlas@master | ||||||
| with: | ||||||
| version: "beta" | ||||||
| - uses: ariga/setup-atlas@v0 | ||||||
| with: | ||||||
| version: "vX.Y.Z" | ||||||
| ``` | ||||||
|
|
||||||
| ### Flavor | ||||||
|
|
||||||
| If you want to install a specific driver flavor of Atlas, you can do so by specifing the `flavor` parameter. | ||||||
| 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" | ||||||
| ``` | ||||||
|
|
||||||
| ### cloud-token | ||||||
|
|
||||||
| The Atlas Cloud token to use for authentication. Must be passed as a secret. | ||||||
| ```yaml | ||||||
| - uses: ariga/setup-atlas@master | ||||||
| with: | ||||||
| cloud-token: ${{ secrets.ATLAS_CLOUD_TOKEN }} | ||||||
| - uses: ariga/setup-atlas@v0 | ||||||
| with: | ||||||
| cloud-token: ${{ secrets.ATLAS_CLOUD_TOKEN }} | ||||||
| ``` | ||||||
|
|
||||||
| ## 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. | ||||||
|
||||||
| 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. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README describes
flavoras selecting a specific driver flavor (e.g. "snowflake"), but the action implementation appears to only check whetherinputs.flavoris non-empty and then prefixes the version withextended-, 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.