GitHub

Creating a github repo

  • To create new repository in GitHub visit this page. Where you will need to fill repository name, description, make it public and click "Create repository" button.
  • Add github remote and push all the changes git remote add origin git@github.com:vendorname/module-name.git. And push all the changes git push origin master

Releases

Creating a release

  • Go to your repository and click "Releases" tab
  • Then click the button "Create a new release"
  • Then in Tag version field insert version. You can read more about semantinc versioning here.
  • Fill in Release title, and write short description.
  • Once you have done all above steps. Press "Publish Release".

That is it, you have published your first release. To confirm that it's really published, visit your repository page "Releases" tab and you should see your newly created release.

Deleting a release

To delete a release click on release heading for example "Initial Release" and then click "Delete" button.

Editing a release

Click on release heading and then click "Edit Release" button.

Pull Requests

Creating Pull Requests in GitHub is a good way of ensuring that the tests you have setup are triggered before you merge any changes into the LIVE / master branch.

This will detail how to use them

Work on your branch

First you need to create your branch and work on it as you normally would.

Once the changes are ready to be merged in, push the branch up to GitHub.

Create the Pull Request

From the repo page on GitHub, click the Pull Requests link in the top menu.

This will take you to a page of open PRs.

Click the green New pull request button, and you will be presented with a helpful list of suggested options to use as the base of your PR

Assuming you have just pushed changes to your branch you should see it near the top of the list. If it is not there, then select it in the compare drop down

Check the changes

At this point you will be able to look at the changes that will be made, before formally creating the request. Use this opportunity to make sure there aren't any silly mistakes, and then click the create pull request button.

Add any useful comments at this point explaining what was done, and try to link through to a ticket if one exists.

Allow the tests to run

The request will be sent to be tested, and other checks may need to be carried out depending on how the repo has been set up. People may make comments on the request asking for explanations or requesting changes

Merging the commit

As long as everything passes, it is then possible to merge the PR into the branch. Once this is done make sure to click the purple button to delete the old branch