gregswindle/github-resource-converter

Export GitHub Issues and Pull Requests to CSV and JSON from your Terminal or Node.js app.

github-resource-converter's Issues

ci(pkg): activate automated dependency updates with Greenkeeper

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

feat(notifications): notify consumers of product updates

1. User story summary

As a consumer,
I would like to know whenever there are updates available for grc
In order to benefit from product enhancements and security fixes.

2. Acceptance criteria

• update-notifier provides update notifications via the CLI.

feat(cli): create a command-line interface that will generate a CSV of a repo's issues

1. User story summary

⌦ Describe what you want to accomplish {do something},
⌦ in what role/capacity {role},
⌦ and why it's important to you {achieve value}.

As a QA engineer,
I want to export GitHub (and GitHub Enterprise) issues to CSV
In order to build reports.

2. Acceptance criteria

⌦ Acceptance criteria define things that must be true when this feature is delivered.

• 1. I can generate CSV files via a command-line interface (CLI).
• 2. I can set the destination directory and name--dest--of the CSV.
• 3. I can set the hostname--host--of the GitHub server.
• 4. I can set the owner--i.e., account name or organization name--to target.
• 5. I can set the repository name--repo--whose issues I want to pull.
• 6. I can optionally set the path-prefix of the GitHub REST API v3 for GitHub Enterprise.
• 7. I can optionally set the protocol for cases in which I need to query a GitHub Enterprise instance that is not encrypted.

chore(release): publish to npm

1. User story: summary of expected behavior

As a maintainer,
I need to publish my last fix to NPM
In order to save resources.

2. Acceptance criteria

• 1. The latest fix and changes are published to the NPM registry.

🐞 3. Steps to reproduce (for defects only)

Travis reported the following error:

Invalid commit message, please fix:
- Commit message line 6 too long: 212 characters, only 100 allowed.
Was: * **save:** implemen[...]
- <subject> must start with a lowercase letter
Commit message was:
chore(release): 1.0.1 [skip ci]
<a name="1.0.1"></a>
* **save:** implement "save" method for Node.js API ([#17](https://github.com/gregswindle/github-resource-converter/issues/17)) ([7e22c30](https://github.com/gregswindle/github-resource-converter/commit/7e22c30))

🐞 4. Your environment (for defects only)

• github-resource-converter version:
• Node.js version (node --version): v8.9.4
• NPM version (npm --version): 5.8.0
• Yarn version (yarn --version): 1.5.1
• Operating System and version (desktop or mobile):

Hardware:

    Hardware Overview:

      Model Name: MacBook Pro
      Model Identifier: MacBookPro11,4
      Processor Name: Intel Core i7
      Processor Speed: 2.8 GHz
      Number of Processors: 1
      Total Number of Cores: 4
      L2 Cache (per Core): 256 KB
      L3 Cache: 6 MB
      Memory: 16 GB
      Boot ROM Version: MBP114.0177.B00
      SMC Version (system): 2.29f24

Software:

    System Software Overview:

      System Version: macOS 10.12.6 (16G1212)
      Kernel Version: Darwin 16.7.0
      Time since boot: 11 days 16:23

• Link to your project: N/A
• Link to RunKit or Repl example: https://runkit.com/gregswindle/github-resource-converter-issue-16

See Travis Build #70, Job #70.2 for details.

defect(save): method "save" is undefined

1. User story: summary of expected behavior

As a consumer,
I should be able to use the github-resource-converter module's save method
In order to programmatically write CSV and JSON files to disk.

2. Acceptance criteria

• 1. Calls to grc.save write data to the destination path I provide.

🐞 3. Steps to reproduce (for defects only)

1. Install and import the module:

const grc = require('github-resource-converter')
// Or 
import * as grc from 'github-resource-converter'

2. Create a simple data structure:

   const data = [{
     "url": "https://api.github.com/repos/democracy-ia/govinfo-link-js/issues/7",
     "repository_url": "https://api.github.com/repos/democracy-ia/govinfo-link-js",
     "labels_url": "https://api.github.com/repos/democracy-ia/govinfo-link-js/issues/7/labels{/name}",
     "comments_url": "https://api.github.com/repos/democracy-ia/govinfo-link-js/issues/7/comments",
     "events_url": "https://api.github.com/repos/democracy-ia/govinfo-link-js/issues/7/events",
     "html_url": "https://github.com/democracy-ia/govinfo-link-js/issues/7",
     "id": 309583334,
     "number": 7,
     "title": "refactor(client): use unmodified javascript-client from swagger-codegen"
   }]

3. Attempt to save the data:

grc.save({ data })

4. The runtime will throw a TypeError:

TypeError: grc.save is not a function

🐞 4. Your environment (for defects only)

• Version of github-resource-converter: v1.0.0

• Node.js version (node --version): 8.9.4

• NPM version (npm --version): 5.8.0

• Yarn version (yarn --version): 1.5.1

• Operating System and version (desktop or mobile):

  💡 MacOS

  • 1. Open a Terminal
  • 2. Run
       system_profiler SPHardwareDataType SPSoftwareDataType -detailLevel mini | pbcopy
  • 3. Paste (command ⌘ + v) below:

  Hardware:
  
   Hardware Overview:
  
     Model Name: MacBook Pro
     Model Identifier: MacBookPro11,4
     Processor Name: Intel Core i7
     Processor Speed: 2.8 GHz
     Number of Processors: 1
     Total Number of Cores: 4
     L2 Cache (per Core): 256 KB
     L3 Cache: 6 MB
     Memory: 16 GB
     Boot ROM Version: MBP114.0177.B00
     SMC Version (system): 2.29f24
  
  Software:
  
   System Software Overview:
  
     System Version: macOS 10.12.6 (16G1212)
     Kernel Version: Darwin 16.7.0
     Time since boot: 11 days 9:28
  

• Link to your project: N/A

• Link to RunKit or Repl example: https://runkit.com/gregswindle/github-resource-converter-issue-16

Question on github-resource-converter

Note: this issue was sent to my (@gregswindle) personal email address.
I have copied and pasted the email body, but left the sender anonymous.

1. User story summary

⌦ Describe what you want to accomplish {do something},
⌦ in what role/capacity {role},
⌦ and why it's important to you {achieve value}.

As a user,
I want to export GitHub issues
In order to review them.

🐞 2. Steps to reproduce (for defects only)

• ⌦ Provide a link to a live example, or

• ⌦ Replace the examples below with an unambiguous sequence of
  ⌦ instructions that end with proof of the defect.

• ⌦ Include source code and log files, if relevant and available.

1. Updated Nodejs via Homebrew (had some issues with some symlinks, but finally got a successful update)

2. Cloned Repo

3. Installed via npm i -g github-resource-converter inside MAC terminal

4. Created the personal access token inside Github and ran this…

   mkdir -p /usr/local/etc/github-resource-center/envvars/
   touch /usr/local/etc/github-resource-center/envvars/.env
   echo "GITHUB_ACCESS_TOKEN="{your-personal-access-token-value}" > \
   /usr/local/etc/github-resource-center/envvars/.env

5. Ran this...

    github-resource-converter \
      --owner gregswindle \
      --repo eslint-plugin-crc \
      --dest './docs/gregswindle-eslint-plugin-crc-issues.csv'

6. I did change all the —owner and --repo but not the —dest but it’s not even getting that far. It doesn’t even see the command in the .bashrc file.

7. bash doesn’t see the command.

   => github-resource-converter \
   | =>   —owner cj***** \
   | =>   —repo Ku****** \
   | =>   --dest './docs/gregswindle-eslint-plugin-crc-issues.csv'
   -bash: github-resource-converter: command not found

If you have any insight. I would greatly appreciate your help.

🐞 3. Your environment (for defects only)

• ⌦ Include as many relevant details about the environment
  ⌦ in which the defect occured.

• Version of github-resource-converter: v1.0.0
• Operating System and version (desktop or mobile): MacOSX 10.3.3
• Link to your project:

Enable semantic-release

1. User story summary

⌦ Describe what you want to accomplish {do something},
⌦ in what role/capacity {role},
⌦ and why it's important to you {achieve value}.

As a maintainer,
I want to automate releases
In order to increase time-to-market.

2. Acceptance criteria

⌦ Acceptance criteria define things that must be true when this feature is delivered.

Example: Job Applicants receive a confirmation email after they submit their resumes.

• 1. semantic-release automatically bumps the semver and publishes to npm.

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml
• The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

• engines was only updated if it defined a single version, not a range.
• .nvmrc was updated to Node.js 10
• .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

build(analytics): track usage with insight

1. User story summary

As a maintainer,
I want to track usage
In order to gain insights and improve the product.

2. Acceptance criteria

• 1. A Google Analytics account for gregswindle/github-resource-converter exists.
• 2. It has custom dimensions for OS, Node Version, and App Version.
• 3. The insight module prompts users to opt-in for tracking.
• 4. Usage statistics are collected on GA.