diff --git a/README.md b/README.md index 39a07e7..9c85c7e 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,7 @@ jobs: steps: - uses: rlespinasse/github-slug-action@v5 - run: echo "Deploying to ${{ env.GITHUB_REF_SLUG }}" + shell: bash ``` [More examples →](docs/guides/) diff --git a/docs/reference/conflicts.md b/docs/reference/conflicts.md index e457446..0a8f8bd 100644 --- a/docs/reference/conflicts.md +++ b/docs/reference/conflicts.md @@ -91,8 +91,7 @@ steps: ## Related Documentation -- [GitHub Variables](reference/github-variables.md) -- [Migration Guide](reference/migration-guide.md) -- [Troubleshooting](reference/troubleshooting.md) +- [Migration Guide](../guides/migration-guide.md) +- [Troubleshooting](troubleshooting.md) Need help? [Open an issue](https://github.com/rlespinasse/github-slug-action/issues/new) diff --git a/docs/reference/troubleshooting.md b/docs/reference/troubleshooting.md index 0683943..85f6678 100644 --- a/docs/reference/troubleshooting.md +++ b/docs/reference/troubleshooting.md @@ -14,6 +14,7 @@ steps: steps: - uses: rlespinasse/github-slug-action@v5 - run: echo ${{ env.GITHUB_REF_SLUG }} + shell: bash ``` ### Variable Scope Issues @@ -27,6 +28,7 @@ jobs: job2: steps: - run: echo ${{ env.GITHUB_REF_SLUG }} # Empty + shell: bash # Solution: Re-run action in each job jobs: @@ -34,18 +36,14 @@ jobs: steps: - uses: rlespinasse/github-slug-action@v5 - run: echo ${{ env.GITHUB_REF_SLUG }} + shell: bash ``` ## Debug Steps ### Enable Debug Logging -```yaml -steps: - - uses: rlespinasse/github-slug-action@v5 - with: - debug: true -``` +Add the variable (or secret) `ACTIONS_STEP_DEBUG` set to true to activate the debug of your workflow. ### Variable Inspection @@ -62,7 +60,6 @@ steps: ## Known Issues -- Case sensitivity on different OS - Special character handling - Unicode support limitations - Environment variable persistence @@ -75,22 +72,13 @@ steps: ```yaml # Use specific version for stability steps: - - uses: rlespinasse/github-slug-action@v5.2.0 -``` - -### OS Compatibility - -```yaml -steps: - - uses: rlespinasse/github-slug-action@v5 - with: - platform: ${{ runner.os }} + - uses: rlespinasse/github-slug-action@v5.0.0 ``` ## Support Resources - [GitHub Issues](https://github.com/rlespinasse/github-slug-action/issues) -- [Documentation](https://github.com/rlespinasse/github-slug-action/blob/main/README.md) +- [Documentation](https://github.com/rlespinasse/github-slug-action/blob/v5.x/README.md) - [Release Notes](https://github.com/rlespinasse/github-slug-action/releases) Need more help? [Open an issue](https://github.com/rlespinasse/github-slug-action/issues/new)