vCheck - Now Available on GitHub

The unbelievably successful vCheck script from Alan Renouf which can be used to provide a daily report on your vSphere (and other technologies) environment is now available on GitHub. This is a great move since it more easily enables further community input to develop this tool further by allowing you to submit contributions via a central repository.

If you’ve not used GitHub before then head over to the home page and create an account. There are clients for different OS flavours depending on your preference. To get started with Windows, download the GitHub for Windows client and login with your account.

If you wish to contribute to the project then head over to the vCheck page and create a fork:

You can now download the project files via the button Clone in Windows:

Your local client will then show the project available to work on:

So now you can start making changes to your local copy and then potentially submit fixes / enhancements:

To make a change, update the files in your local repository and send a commit up to your fork, preferably with comments on the changes that you made:

To submit these changes to the original project create a Pull Request - the details from your commit should be automatically populated:

Once the changes have been accepted by the project owner, you’ll see them incorporated on the Commits page of the original project:

Once other people start making changes, at some point you’ll want to update your fork and local repository with these updates. To do that you’ll need to head to the command line, since you can’t currently do that directly from the Windows client. You can open a shell into the right place, which will open a PowerShell console with the Git tools available.

Firstly you need to add the original project https://github.com/alanrenouf/vCheck-vSphere as an upstream

[plain]

git remote add upstream https://github.com/alanrenouf/vCheck-vSphere.git

[/plain]

Then fetch the upstream:

[plain]

git fetch upstream

[/plain]

Finally, merge the changes:

[plain]

git merge upstream/master

[/plain]

You’ll now have the updated files locally. Synchronise your client with your fork on GitHub and that will be up-to-date too.

Look forward to other people joining this project!