Github app for MacOSX

[Soma]

MacOSX Github App first steps

Since ProcessWire modules directory supports and encourages you to use github for publishing modules and third-party content here's a little help getting started with github for mac.

1. Go and install the app for mac here http://mac.github.com/
   
2. You'll have to first create a github account to where you can connect. Creating public repos is free, on top you'll see a "Free for open source" and a small button. https://github.com/plans
   
3. Login in from your newly installed github app.
   
4. Create new local repository by simply dragging the folder (your module) right into the app. The folder can be anywhere on your computer, maybe you choose to use the github folder automaticly created under ~user folder, or you decide. After you added it to github you'll see added a ".git" folder in your local repositiory.
   
5. Now you'll see your files added in the app. Maybe you'll see the annoying ".DS_Store" file in there too. To ignore files simply right click on them and select "ignore". It will get added to the .gitignore file which now also appears in the files. Do the same and ignore it too.
   
6. Now push the newly created repo to github using the button top right "Push to github". You'll be asked to enter a title and description then you can push it. It now will appear on github, but still empty.
   
7. Now make your first initial commit, add a description i.e. "inital commit" and press "Commit" button. You'll see it add's a "Unsynced Commits" panel underneath. Press the button on top right "Publish branch" button and it will push it to the remote repository.
   
8. You should now be able to see the files commited on your github page.
   
9. On the repository page you'll see a "ZIP" download button. You can use that url to enter in the download field for the module when you add it to http://modules.processwire.com. Once you update the module, you have to enter a new version both in the module getModuleInfo() and on the module page. This makes sure people, also some apps using the webservice, know it is new and can update it.
   

Screencats

The following is a short screencats (no audio) showing me adding a new repositiory to github and update it using the mac github app.

Screencast using MacGithubApp

[Martijn Geerts]

Thank You !

[ryan]

This is great Soma, thanks for writing this. I'm finally going to have to try out the GitHub client for Mac myself (I've been just using command line).

[thijs]

I’ve also been using the github app for osx for some time now; the only thing missing in my opinion is the possibility to add some kind of hook to make a mysql_dump and sync it along with the rest of the repository. That would be a major workflow improvement. I know this should be possible with command line git, but perhaps you know a solution?

(There is also Tower, a mac osx git app, which does seem to support pre-commit hooks)

edit; could use a remote mysql server to get rid of the issue but that would probably kill some of the benefits of developing locally

[Wanze]

Thank you, this tutorial helped me to understand how Git works.

Just wondering:

Where are your local repositories of Processwire modules stored?

Directly in the site/modules folder of a Processwire installation in the Document Root or somewhere else?

[Soma]

I’ve also been using the github app for osx for some time now; the only thing missing in my opinion is the possibility to add some kind of hook to make a mysql_dump and sync it along with the rest of the repository. That would be a major workflow improvement. I know this should be possible with command line git, but perhaps you know a solution?

(There is also Tower, a mac osx git app, which does seem to support pre-commit hooks)

edit; could use a remote mysql server to get rid of the issue but that would probably kill some of the benefits of developing locally

To be honest I have no clue. I never used it for that

@wanze

I store them in a separate folder where I have all PW modules. The local install is for development only, once it's good I copy files or code over.