diff options
| author | Paul C. Buetow (mars.fritz.box) <paul@buetow.org> | 2014-06-22 11:35:17 +0200 |
|---|---|---|
| committer | Paul C. Buetow (mars.fritz.box) <paul@buetow.org> | 2014-06-22 11:35:17 +0200 |
| commit | 920dbc32082169fbcdf8f64ba89e64cef97745dd (patch) | |
| tree | 1029b463deaa997c494a6d0765874edec5acc34e | |
| parent | 481244551b413ca2be2792ff1b393dd5b945de6b (diff) | |
New release
| -rw-r--r-- | .version | 2 | ||||
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | README.pod | 86 | ||||
| -rw-r--r-- | README.txt | 72 | ||||
| -rw-r--r-- | debian/changelog | 6 | ||||
| -rw-r--r-- | debian/files | 2 | ||||
| -rw-r--r-- | docs/japi.1 | 2 |
7 files changed, 98 insertions, 76 deletions
@@ -1 +1 @@ -0.4.2 +0.4.3 @@ -33,7 +33,9 @@ documentation: pod2man --release="$(NAME) $$(cat .version)" \ --center="User Commands" ./docs/$(NAME).pod > ./docs/$(NAME).1 # Also write README.txt for Github. - pod2text ./docs/$(NAME).pod | tee ./docs/$(NAME).txt > README.txt + pod2text ./docs/$(NAME).pod >./docs/$(NAME).txt + # For github page + cp ./docs/$(NAME).pod README.pod # Build a debian package (don't sign it, modify the arguments if you want to sign it) deb: all diff --git a/README.pod b/README.pod new file mode 100644 index 0000000..8a080af --- /dev/null +++ b/README.pod @@ -0,0 +1,86 @@ +=head1 NAME + +japi - A Humble Jira API Tool + +This is a small and simple command line tool to be used manually or via cron to fetch the newest unresolved and unclosed tickets from a Jira project. + +It might be usefull to write the results every hour to a local file and do a C<cat ~/.issues> every time you open a new shell. + +CAUTION: You may also need to install the C<JIRA::REST> module from CPAN manually. It's not included in standard Debian GNU/Linux Wheezy yet. + +=head1 SYNOPSIS + +Synopsis: japi + [--debug] + [--help] + [--version] + [--nocolor] + [--passfile] + [--unassigned] + [--jira_apiversion STRING] + [--jira_query STRING] + [--jira_uribase STRING] + [--jira_user STRING] + +=head2 Options: + +=over + +=item --debug + +Prints out extra debugging infos during execution. + +=item --help + +Prints out the help. + +=item --version + +Prints out the version. + +=item --nocolor + +By default the output uses colored text output. This switch disables it. + +=item --passfile STRING + +Specifies the path to an optional file which includes the Jira API password but Base64 encoded. The default value is C<~/.japipass>. + +If the file is not present, Japi will prompt for the password. + +=item --unassigned + +By default the output lists assigned and unassigned issues. Use this switch to only list unassigned issues. + +=item --jira_apiversion STRING + +Specifies the Jira API version to use. The default value is C<rest/api/2>. + +=item --jira_query STRING + +Specifies the Jira search string (e.q. a JQL string). The default value is C<search?jql=project=MT and status not in (Resolved,Closed)>. + +=item --jira_uribase STRING + +Specifies the Jira URI base. The default value is C<https://your-jira.example.com>. This has to be changed. + +=item --jira_user STRING + +Specifies the Jira user. The default value is your current Linux/UNIX user. + +=back + +=head1 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. + +It can be created like this: + + bash -c 'read -s PASSWORD; tr -d "\n" <<< "$PASSWORD" | base64' | tee ~/.japipass + chmod 0600 ~/.japipass + +=head1 AUTHOR + +Paul C. Buetow - <paul@buetow.org> + +=cut diff --git a/README.txt b/README.txt deleted file mode 100644 index 7b1043b..0000000 --- a/README.txt +++ /dev/null @@ -1,72 +0,0 @@ -NAME - japi - A Humble Jira API Tool - - This is a small and simple command line tool to be used manually or via - cron to fetch the newest unresolved and unclosed tickets from a Jira - project. - - It might be usefull to write the results every hour to a local file and - do a "cat ~/.issues" every time you open a new shell. - - CAUTION: You may also need to install the "JIRA::REST" module from CPAN - manually. It's not included in standard Debian GNU/Linux Wheezy yet. - -SYNOPSIS - Synopsis: japi [--debug] [--help] [--version] [--nocolor] [--passfile] - [--unassigned] [--jira_apiversion STRING] [--jira_query STRING] - [--jira_uribase STRING] [--jira_user STRING] - - Options: - --debug - Prints out extra debugging infos during execution. - - --help - Prints out the help. - - --version - Prints out the version. - - --nocolor - By default the output uses colored text output. This switch disables - it. - - --passfile STRING - Specifies the path to an optional file which includes the Jira API - password but Base64 encoded. The default value is "~/.japipass". - - If the file is not present, Japi will prompt for the password. - - --unassigned - By default the output lists assigned and unassigned issues. Use this - switch to only list unassigned issues. - - --jira_apiversion STRING - Specifies the Jira API version to use. The default value is - "rest/api/2". - - --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)". - - --jira_uribase STRING - Specifies the Jira URI base. The default value is - "https://your-jira.example.com". This has to be changed. - - --jira_user STRING - Specifies the Jira user. The default value is your current - Linux/UNIX user. - -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. - - It can be created like this: - - bash -c 'read -s PASSWORD; tr -d "\n" <<< "$PASSWORD" | base64' | tee ~/.japipass - chmod 0600 ~/.japipass - -AUTHOR - Paul C. Buetow - <paul@buetow.org> - diff --git a/debian/changelog b/debian/changelog index dab8251..1df19cb 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +japi (0.4.3) stable; urgency=low + + * Add README.pod for Github + + -- Paul Buetow <paul@buetow.org> Sun, 22 Jun 2014 11:34:54 +0200 + japi (0.4.2) stable; urgency=low * Merge diff --git a/debian/files b/debian/files index b7cc84e..3b77d04 100644 --- a/debian/files +++ b/debian/files @@ -1 +1 @@ -japi_0.4.2_all.deb utils optional +japi_0.4.3_all.deb utils optional diff --git a/docs/japi.1 b/docs/japi.1 index 9638c48..778b62e 100644 --- a/docs/japi.1 +++ b/docs/japi.1 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "JAPI 1" -.TH JAPI 1 "2014-03-18" "japi 0.4.2" "User Commands" +.TH JAPI 1 "2014-06-22" "japi 0.4.3" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l |
