Skip to content

Commit

Permalink
some tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
rlespinasse committed Nov 3, 2024
1 parent 68a3410 commit b3f79aa
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 21 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/conflicts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
24 changes: 6 additions & 18 deletions docs/reference/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ steps:
steps:
- uses: rlespinasse/github-slug-action@v5
- run: echo ${{ env.GITHUB_REF_SLUG }}
shell: bash
```
### Variable Scope Issues
Expand All @@ -27,25 +28,22 @@ jobs:
job2:
steps:
- run: echo ${{ env.GITHUB_REF_SLUG }} # Empty
shell: bash

# Solution: Re-run action in each job
jobs:
job2:
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

Expand All @@ -62,7 +60,6 @@ steps:

## Known Issues

- Case sensitivity on different OS
- Special character handling
- Unicode support limitations
- Environment variable persistence
Expand All @@ -75,22 +72,13 @@ steps:
```yaml
# Use specific version for stability
steps:
- uses: rlespinasse/[email protected]
```
### OS Compatibility
```yaml
steps:
- uses: rlespinasse/github-slug-action@v5
with:
platform: ${{ runner.os }}
- uses: rlespinasse/[email protected]
```

## 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)

0 comments on commit b3f79aa

Please sign in to comment.