Apex offers integration with Github, allowing you to take advantage of the collaboration and project management functionality of Github while developing and maintaining Apex based packages.
To create a new Apex package that will be used in conjunction with Github, complete the following steps:
That's it! The package has now been published to the Apex repository, and can be instantly installed on any APex installation. Plus the source code is on Github, allowing for standard collaboration and project management. Upon installing the package into an Apex installation, the source code will now be downloaded directly from the Github repository instead of the Apex repository.
The Github integration still retains hands free version control within Apex packages. Upon initially publishing the package, to release an upgrade complete the following steps:
That's it! When you publish an upgrade, the Apex repository will retrieve the contents of the Github repository, scan the files for modifications compared to the previous version, and include any modified files within the upgrade.
To contribute to an existing Apex package, ensure you have Apex installed locally, and complete the following steps:
That's it! When you publish the upgrade, the Apex repository will notice an upstream URL is defined, hence will treat it as a pull request within GIthub that still has to be merged into the master branch, and will not actually commit the changes to the Apex repository. Instead, it will simply generate the git.sh script that includes all modified files. You can go ahead and continue publishing upgrades as desired for each commit you wish to make to the Github repository.
Sync from Github Repository
At times you may wish to sync your local Apex installation of a package with the current codebase of the Github
repository. For example, if several pull requests were merged into the master branch, you may want to upgrade your local installation to the latest
codebase. This can be done with the
This will download the package contents from the Github repository, scan all files, and update the codebase on your local Apex installation to the latest code.
Need a Professional?
Need development work by the creator of Apex? E-mail email@example.com for a free consultation.
Subscribe to the low traffic mailing list to stay updated on Apex.