Troubleshooting Guide
This guide provides solutions to common issues you may encounter when using sley. If you don't find your issue here, please check the GitHub Issues or open a new one.
Quick Diagnostics
Using the doctor command
Validate your .version file and configuration:
bash
sley doctor
# Or use the alias
sley validateThis checks:
- Whether
.versionfile exists and is readable - Whether the version format is valid (semantic versioning)
- Basic configuration validation
Enable debug mode
For detailed troubleshooting output, use the verbose flag with any command:
bash
# Most commands support verbose output
sley bump patch --verbose
sley show --all --verbose
sley discover --format jsonYou can also check your configuration:
bash
# Verify sley.yaml is being read correctly
cat .sley.yaml
# Check current version
sley show
# Discover modules and version sources (monorepo)
sley discoverBrowse by Category
Find solutions based on the type of issue you're experiencing:
| Category | Common Issues |
|---|---|
| .version File Issues | File not found, invalid format, permission denied, empty file |
| Plugin Errors | Plugin not found, release gate validation, changelog generation, dependency check |
| Git & Tag Issues | Tag already exists, not a git repository, push failures, GPG signing |
| CI/CD Issues | Interactive prompts, permission denied, detached HEAD, changes not committed |
| Monorepo Issues | No modules found, module not detected, interactive mode, parallel execution |
| Configuration Issues | Invalid YAML, configuration not being applied |
| Advanced Topics | Debugging workflows, version rollback, performance optimization, migration |
Getting Help
If you can't resolve your issue:
- Check the GitHub Issues for similar problems
- Enable verbose output and include it in your bug report
- Provide your
.sley.yamlconfiguration - Include sley version:
sley --version - Describe your environment (OS, CI/CD platform, git version)
Create a bug report:
bash
# Gather diagnostic information
sley --version
sley doctor
sley discover
git --version
cat .sley.yaml
env | grep SLEY
# Include this information when opening an issueSee Also
- CLI Reference - Complete command reference
- Configuration - Configuration options and precedence
- CI/CD Integration - CI/CD-specific solutions
- Monorepo Support - Multi-module troubleshooting
- Plugin System - Plugin-specific documentation