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.

GitHub1

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

GitHub3

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

GitHub4

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

GitHub2

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

GitHub5

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:

GitHub6

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

GitHub7

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

GitHub8

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.

GitHub9

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

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

Then fetch the upstream:

git fetch upstream

Finally, merge the changes:

git merge upstream/master

GitHub10

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

GitHub11

Look forward to other people joining this project!

2 thoughts on “vCheck – Now Available on GitHub

Comments are closed.