diff options
Diffstat (limited to 'docs/japi.txt')
| -rw-r--r-- | docs/japi.txt | 137 |
1 files changed, 37 insertions, 100 deletions
diff --git a/docs/japi.txt b/docs/japi.txt index 7cfd093..9096b46 100644 --- a/docs/japi.txt +++ b/docs/japi.txt @@ -1,116 +1,53 @@ NAME - japi - A template project + japi - A Humble Jira API Tool -WTF? - You may use this project in order to build your own Debian package for - your own project. This has been tested with Debian GNU/Linux Squeeze and - Debian GNU/Linux Wheezy. +SYNOPSIS + Synopsis: japi [--debug] [--help] [--version] [--passfile] + [--jira_apiversion <STRING>] [--jira_query <STRING>] [--jira_uribase + <STRING>] [--jira_user <STRING>] - Feel free to modify any aspects. This project is just an empty example - japi. + Options: + --debug + Prints out extra debugging infos during execution. - Follow these steps: + --help + Prints out the help. - Install required packages - Run the following: + --version + Prints out the version. - sudo aptitude install lintian devscripts dpkg-dev make perl + --passfile <STRING> + Specifies the path to an optional file which includes the Jira API + password but Base64 encoded. The default value is "~/.japipass". - Todo: Ensure this are the correct packages. In order to test that I - would have to setup a blank Debian system. + If the file is not present, Japi will prompt for the password. - Compile the project - Go to the to level directory and run + --jira_apiversion <STRING> + Specifies the Jira API version to use. The default value is + "rest/api/2". - make + --jira_query <STRING> + Specifies the Jira search string (e.q. a JQL string). The default + value is "search?jql=project=MT and status not in + (Resolved,Closed)'". - To test run + --jira_uribase <STRING> + Specifies the Jira URI base. The default value is + "https://your-jira.example.com". This has to be changed. - ./bin/japi + --jira_user <STRING> + Specifies the Jira user. The default value is your current + Linux/UNIX user. - It should print out the version number of the project. +CONFIG + Almost all options have to be passed the Japi tool via command line. One + exception is the password file containing your Jira password Base64 + encoded. - Create a Debian package - Go to the to level directory and run + It can be created like this: - make deb + bash -c 'read -s PASSWORD; tr -d "\n" <<< "$PASSWORD" | base64' | tee ~/.japipass - It will create the files like: - - ../japi_0.0.0.0_all.deb - ../japi_0.0.0.0.dsc - ../japi_0.0.0.0_amd64.changes - ../japi_0.0.0.0.tar.gz - - It should create a debian package in ../. Check and install it, e.g: - - lintian --pedantic ../japi_0.0.0.0_all.deb - sudo dpkg -i ../japi_0.0.0.0_all.deb - - Run - - dpkg -L japi - - to see whats in there. You can now run - - /usr/bin/japi - - or for example - - man japi - - Read the Makefile - Read the Makefile in order to understand what's going on. - -Customize - Now, since you understood everything feel free to customize everything - the way you want it. E.g.: - - Don't use POD for documentation but LaTeX - - Compile a C program - - Include a ./lib dir, add it to the 'install' Makefile rule - - etc etc. - - You should also consider the following: - - Manual page - This template is using POD for creating manual pages. Edit - ./docs/japi.pod and run - - make documentation - - in order to build ./docs/japi.1. The page will be included in the - resulting debian package automatically. You can review the page with - - man ./docs/japi.1 - - Renaming japi into your project name - Rename all files which have *japi* included into your own new package - name. You can do that with: - - PROJECTNAME=yourproject - find . -name \*japi\* | - while read japi; do git mv $japi ${japi/japi/$PROJECTNAME}; done - - Search all content and rename *japi* into your own new package name. You - can do that with: - - grep -R japi . | grep -v .git | - cut -d: -f1 | uniq | xargs sed -i "s/japi/$PROJECTNAME/g" - - Updating ./debian - Edit the following files accordingly to your new project (e.g. with - vim): - - ./debian/control - ./debian/copyright - ./debian/README - - Update changelog - Go to the to level directory and run - - dch -i +AUTHOR + Paul C. Buetow - <paul@buetow.org> |