Skip to content

Commit

Permalink
i #275 Add JIRA Downloader/Refresher
Browse files Browse the repository at this point in the history
Adds Downloader and Refresher for JIRA issues 
and comments. The downloader no longer relies
on JirAgileR. A new Notebook was added showcasing
both the Downloader and Parser functionality in
conjunction, replacing the prior one which still
had the external dependency.

Signed-off-by: Carlos Paradis <carlosviansi@gmail.com>
Co-authored-by: Carlos Paradis <carlosviansi@gmail.com>
Signed-off-by: Sean Sunoo <97641529+Ssunoo2@users.noreply.github.com>
Co-authored-by: Sean Sunoo <97641529+Ssunoo2@users.noreply.github.com>
  • Loading branch information
Ssunoo2 and carlosparadis committed Apr 15, 2024
1 parent fb2618e commit c781106
Show file tree
Hide file tree
Showing 14 changed files with 1,134 additions and 150 deletions.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Authors@R: c(
person('Waylon', 'Ho', role = c('ctb')),
person('Nicole', 'Hoess', role = c('ctb')),
person('Anthony', 'Lau', role = c('ctb')),
person('Sean', 'Sunoo', role = c('ctb')),
person('Ian Jaymes', 'Iwata', role= c('ctb'))
)
Maintainer: Carlos Paradis <cvas@hawaii.edu>
Expand Down
4 changes: 4 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ export(download_bugzilla_perceval_traditional_issue_comments)
export(download_bugzilla_rest_comments)
export(download_bugzilla_rest_issues)
export(download_bugzilla_rest_issues_comments)
export(download_jira_issues)
export(download_jira_issues_by_date)
export(download_jira_issues_by_issue_key)
export(download_mod_mbox)
export(download_mod_mbox_per_month)
export(download_pipermail)
Expand Down Expand Up @@ -134,6 +137,7 @@ export(query_src_text_class_names)
export(query_src_text_namespace)
export(read_temporary_file)
export(recolor_network_by_community)
export(refresh_jira_issues)
export(smell_missing_links)
export(smell_organizational_silo)
export(smell_radio_silence)
Expand Down
4 changes: 3 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ __kaiaulu 0.0.0.9700 (in development)__

### NEW FEATURES

* `make_jira_issue()` and `make_jira_issue_tracker()` no longer create fake issues following JirAgileR format, but instead the raw data obtained from JIRA API. This is compatible with the new parser function for JIRA. [#277](https://github.com/sailuh/kaiaulu/issues/277)
* `refresh_jira_issues()` had been added. It is a wrapper function for the previous downloader and downloads only issues greater than the greatest key already downloaded.
* `download_jira_issues()`, `download_jira_issues_by_issue_key()`, and `download_jira_issues_by_date()` has been added. This allows for downloading of Jira issues without the use of JirAgileR [#275](https://github.com/sailuh/kaiaulu/issues/275) and specification of issue Id and created ranges. It also interacts with `parse_jira_latest_date` to implement a refresh capability.
* `make_jira_issue()` and `make_jira_issue_tracker()` no longer create fake issues following JirAgileR format, but instead the raw data obtained from JIRA API. This is compatible with the new parser function for JIRA. [#277](https://github.com/sailuh/kaiaulu/issues/277)
* `parse_jira()` now parses folders containing raw JIRA JSON files without depending on JirAgileR. [#276](https://github.com/sailuh/kaiaulu/issues/276)
* The `parse_jira_latest_date()` has been added. This function returns the file name of the downloaded JIRA JSON containing the latest date for use by `download_jira_issues()` to implement a refresh capability. [#276](https://github.com/sailuh/kaiaulu/issues/276)
* Kaiaulu architecture has been refactored. Instead of using a parser, download, network module structure, Kaiaulu now uses a combination of data type and tool structure. In that manner, various parser functions of download,R, parser.R, and network.R now are separated in git.R, jira.R, git.R, etc. When only small functionality of a tool is required, functions are grouped based on the data type they are associated to, for example, src.R. Kaiaulu API documentation has been updated accordingly. Functions signature and behavior remain the same: The only modification was the new placement of functions into files. For further rationale and changes, see the issue for more details. [#241](https://github.com/sailuh/kaiaulu/issues/241)
Expand Down
504 changes: 500 additions & 4 deletions R/jira.R

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ reference:
- parse_jira_rss_xml
- make_jira_issue
- make_jira_issue_tracker
- download_jira_issues_comments
- download_jira_issues_comments_by_date
- download_jira_issues_comments_by_issuekey
- refresh_jira_issues_comments_by_issuekey
- title: __GitHub__
desc: >
Functions to interact and download data from GitHub API.
Expand Down
4 changes: 2 additions & 2 deletions conf/geronimo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ issue_tracker:
domain: https://issues.apache.org/jira
project_key: GERONIMO
# Download using `download_jira_data.Rmd`
issues: ../../rawdata/issue_tracker/geronimo/issues
issue_comments: ../../rawdata/issue_tracker/geronimo/issue_comments
issues: ../../rawdata/issue_tracker/geronimo/issues/
issue_comments: ../../rawdata/issue_tracker/geronimo/issue_comments/
github:
# Obtained from the project's GitHub URL
owner: apache
Expand Down
8 changes: 4 additions & 4 deletions conf/kaiaulu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ mailing_list:
issue_tracker:
jira:
# Obtained from the project's JIRA URL
#domain: https://issues.apache.org/jira
#project_key: GERONIMO
domain: https://sailuh.atlassian.net
project_key: SAILUH
# Download using `download_jira_data.Rmd`
#issues: ../../rawdata/issue_tracker/geronimo_issues.json
#issue_comments: ../../rawdata/issue_tracker/geronimo_issue_comments.json
issues: ../../rawdata/issue_tracker/kaiaulu/issues/
issue_comments: ../../rawdata/issue_tracker/kaiaulu/issue_comments/
github:
# Obtained from the project's GitHub URL
owner: sailuh
Expand Down
80 changes: 80 additions & 0 deletions man/download_jira_issues.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

85 changes: 85 additions & 0 deletions man/download_jira_issues_by_date.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

80 changes: 80 additions & 0 deletions man/download_jira_issues_by_issue_key.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 3 additions & 4 deletions man/parse_jira_latest_date.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c781106

Please sign in to comment.