So! You're having problems with BoxCI. This file is here to help. If you're running into an error, try reading the rest of this file for help. If you can't figure out how to solve your problem, there are also instructions on how to report a bug.
Instructions for common BoxCI uses can be found on the BoxCI documentation site.
Detailed information about each BoxCI command, including help with common problems, can be found in the BoxCI documentation site.
First, figure out exactly what it is that you're trying to do. Then, go to the BoxCI documentation website and see if we have instructions on how to do that.
Hopefully the troubleshooting steps above resolved your problem. If things still aren't working the way you expect them to, please let us know so that we can diagnose and hopefully fix the problem you're having.
The best way to report a bug is by providing a reproduction script.
A half working script with comments for the parts you were unable to automate is still appreciated.
If you are unable to do that, please include the following information in your report:
- What you're trying to accomplish
- The command you ran
- What you expected to happen
- What actually happened
- The exception backtrace(s), if any
- What version of BoxCI you are using (run
boxci --verson
) - What version of Ruby you are using (run
ruby -v
)
Create a gist containing all of that information, then visit the BoxCI issue tracker and create a ticket describing your problem and linking to your gist.
Thanks for reporting issues and helping make BoxCI better! We really appreciate it.