IN MAINTENANCE MODE
Zendesk Apps Tools is in maintenance mode. This means no additional feature enhancements or non-security bugs will be fixed. We recommend switching to using ZCLI for our best CLI experience.
Zendesk Apps Tools
Zendesk Apps Tools (ZAT) are a collection of local development tools that simplify building and deploying Zendesk apps.
This repo is owned and maintained by the Zendesk Apps team. You can reach us on email@example.com. We are located in Melbourne.
Install and use ZAT
ZAT is a Ruby gem. You don't need to know Ruby to use the tools but you do need to install Ruby to install the gem.
To install, run
gem install zendesk_apps_tools.
To get the latest version, run
gem update zendesk_apps_tools.
For information on using the tools, see Zendesk App Tools on developer.zendesk.com.
Work on ZAT
If you want to help develop this tool, clone this repo and run
ZAT uses a gem called ZAS. If you're developing ZAT, you'll probably want to edit code in ZAS too. To do so, you need to clone the ZAS repo and add the following line at the end of
Gemfile in the ZAT project:
gem 'zendesk_apps_support', path: '../zendesk_apps_support'
Then, comment-out the line referring to
zendesk_apps_support in this project's
# s.add_runtime_dependency 'zendesk_apps_support', '~> X.YY.ZZ'
The path should point to your local ZAS directory. In this way, your clone of ZAT will use a local version of ZAS, which is very helpful for development. Run a
bundle install after changing the Gemfile.
- To bump ZAT version, run
bump patch|minor|major --no-bundlefrom the root directory. Note:
--no-bundleis required in order to prevent
bundle updatecommand from running, which is by default triggered by the bump gem and could lead to incompatible dependencies.
- To publish ZAT to Rubygems, run
bundle exec rake release.
This project uses rspec, which you can run with
bundle exec rake.
Improvements are always welcome. To contribute:
- Put up a PR into the master branch.
- CC and get two +1 from @zendesk/vegemite.
This repo contains the ZAT documentation published on the developer portal at https://developer.zendesk.com. Please cc @zendesk/documentation on any PR that adds or updates the documentation.
You can report bugs as issues here on GitHub. You can also submit a bug to firstname.lastname@example.org. Mention "zendesk_apps_tools" in the ticket so it can be assigned to the right team.
Copyright and license
Copyright 2013 Zendesk Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.