gatoreducator / dockagator Goto Github PK

The following command in the README file is incorrect:

docker run --rm --name dockagator \
  -v "$(pwd)":/project \
  -v "$HOME/.gatorgrader":/root/.local/share \
  gatoreducator/dockagator

I think that the directory should be .dockagator and not .gatorgrader.

Finally, I like the idea of using .dockagator instead of .gatorgrader because that will distinguish between the directory used to store Docker-related details and the directory used to store an implementation of GatorGrader as created by the Gradle plugin.

Thanks for creating this material @Michionlion, it is exceptional. I should note that I am glad to make this proposed change and the change in issue #1 but I'm raising these issues as a reminder and to give me something to reference in the upcoming PRs.

The Travis CI badge in the README indicates that the build is currently failing. We should investigate why it is failing and resolve this issue so that the it passes and the badge is correct.

When I have previously tried to use variables like $HOME and $pwd as mentioned in the documentation, my experience is that they do not work correctly when you are running the suggested Docker commands in cmd on Windows 10 Pro and Windows 10 Enterprise.

With that said, I have not had enough time to test this extensively and on all of the different shells and combinations of Windows-based operating system and shell.

Since I did not want to forget this concern, I thought to raise the issue now and to start a conversation about how it might be possible for us to write those commands in a more general fashion. Or, do we also need to provide example Windows commands that will work and instead use variables like %cd%? Here is a reference:

https://stackoverflow.com/questions/921741/windows-equivalent-to-unix-pwd

Okay, let me know what you think @Michionlion! I'm glad to update the documentation in a PR if we can identify a general-purpose way to write the documentation commands that work either for MacOS and Linux or Windows 10 Pro and Windows 10 Enterprise.