| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
Current coverage is 90.02% (diff: 93.84%)
|
Sorry, something went wrong.
There was a problem hiding this comment.
Thanks for the great work!
The only question I have is what did you brea? I don't see what changes require a major version bump.
Sorry, something went wrong.
| node_js: | ||
| - '6' | ||
| - '5' | ||
| - '4' |
There was a problem hiding this comment.
How much longer is node4 supported? Maybe we don't drop support for node4 just yet.
Sorry, something went wrong.
There was a problem hiding this comment.
we are not dropping the support for node4, just node 0.12 and earlier. I removed it from the test cause there were some issues with running the test 3 times in parallel. But maybe we should test on node4 only
Sorry, something went wrong.
There was a problem hiding this comment.
This may be solved by running them serially: https://docs.travis-ci.com/user/customizing-the-build#Limiting-Concurrent-Builds
Sorry, something went wrong.
| ## GitHub Tools | ||
|
|
||
| The team behind Github.js has created a whole organization, called [GitHub Tools](https://github.com/github-tools), | ||
| dedicated to GitHub and its API. In the near future this repository could be moved under the GitHub Tools organization |
There was a problem hiding this comment.
Was moved to org
Sorry, something went wrong.
| * @param {number|string} number - the number of the pull request to update | ||
| * @param {Object} options - the pull request description | ||
| * @param {Requestable.callback} [cb] - will receive the pull request information | ||
| * @return {Promise} - the promise for the http request |
There was a problem hiding this comment.
Lolz
Sorry, something went wrong.
There was a problem hiding this comment.
@clayreimann You were asking about a breaking change that would necessitate a major version bump. This would be it.
Sorry, something went wrong.
| const url = this.__getURL(path); | ||
| const headers = this.__getRequestHeaders(raw); | ||
|
|
||
| const AcceptHeader = (data || {}).AcceptHeader; |
There was a problem hiding this comment.
acceptHeader?
Sorry, something went wrong.
There was a problem hiding this comment.
the header is call Accept so I wasn't sure. I have no strong feeling about it
Sorry, something went wrong.
There was a problem hiding this comment.
I think @clayreimann is getting at the usage of PascalCasing instead of camelCasing.
Sorry, something went wrong.
There was a problem hiding this comment.
yes I understood
Sorry, something went wrong.
| "name": "github-api", | ||
| "version": "2.4.0", | ||
| "name": "@mathieudutour/github-api", | ||
| "version": "3.2.0", |
There was a problem hiding this comment.
Is this diff still relevant?
Sorry, something went wrong.
There was a problem hiding this comment.
it's not, I will roll back those changes. I wasn't sure you were interested in merging such a PR so I waited for that first ;)
Sorry, something went wrong.
| (found, member) => member.login === testUser.USERNAME || found, | ||
| false | ||
| ); | ||
| const hasTestUser = members.some((member) => member.login === testUser.USERNAME); |
There was a problem hiding this comment.
👍 Yay conciseness!
Sorry, something went wrong.
| # switch back to master, build and publish | ||
| git checkout master | ||
| npm run build | ||
| npm publish |
There was a problem hiding this comment.
Isn't this done by CI?
Sorry, something went wrong.
There was a problem hiding this comment.
indeed, I'll roll back also
Sorry, something went wrong.
| cache: | ||
| directories: | ||
| - node_modules | ||
| before_install: npm install -g npm@latest |
There was a problem hiding this comment.
What's the reasoning for not using the latest version of npm?
Sorry, something went wrong.
| dedicated to GitHub and its API. In the near future this repository could be moved under the GitHub Tools organization | ||
| as well. In the meantime, we recommend you to take a look at other projects of the organization. | ||
|
|
||
| ## Samples |
There was a problem hiding this comment.
What's the thought behind removing all this documentation? Are you proposing we drop the link to the generated Docs?
Sorry, something went wrong.
There was a problem hiding this comment.
It's not removed, it's rearranged to fit https://github.com/noffle/art-of-readme
Sorry, something went wrong.
|
|
||
| ```javascript | ||
| import GitHub from 'github-api'; | ||
| var GitHub = require('github-api'); |
There was a problem hiding this comment.
Why downgrade from ECMA2015?
Sorry, something went wrong.
There was a problem hiding this comment.
hum, because for people who are not using babel/ES6, it's an additional cognitive load which can be avoided. For people using ES6, I'm quite sure they know how to use const instead of var.
But again, no strong feeling and happy to roll back if you prefer
Sorry, something went wrong.
There was a problem hiding this comment.
My opinion is that ECMA2015 is spec now, so there's no need to downgrade.
Sorry, something went wrong.
There was a problem hiding this comment.
sure, but var is not deprecated in anyway, so if we can help people understand the repo, I think it's best, regardless of wether it's matching style guide or not, don't you think? (see #392)
Sorry, something went wrong.
There was a problem hiding this comment.
My idea was, and hope is, that we can have at least one example of each of: require vs import and then vs cb to give people the full flavor of the API.
That being said I think that perhaps that means most of our examples are import + then with an example included toward the end of require + cb.
Sorry, something went wrong.
There was a problem hiding this comment.
That might be a solution. Feel free to commit on directly here
Sorry, something went wrong.
|
|
||
| // basic auth | ||
| const gh = new GitHub({ | ||
| var gh = new GitHub({ |
There was a problem hiding this comment.
Again downgrading from ECMA2015?
Sorry, something went wrong.
| }); | ||
|
|
||
| const me = gh.getUser(); | ||
| var me = gh.getUser(); // no user specified defaults to the user for whom credentials were provided |
There was a problem hiding this comment.
Another downgrade from ECMA2015, I'll stop mentioning all the ones I see now.
Sorry, something went wrong.
| * @param {number|string} number - the number of the pull request to update | ||
| * @param {Object} options - the pull request description | ||
| * @param {Requestable.callback} [cb] - will receive the pull request information | ||
| * @return {Promise} - the promise for the http request |
There was a problem hiding this comment.
@clayreimann You were asking about a breaking change that would necessitate a major version bump. This would be it.
Sorry, something went wrong.
| let remoteIssues; | ||
|
|
||
| before(function() { | ||
| before(function(done) { |
There was a problem hiding this comment.
Mocha allows you to return a promise chain instead of passing the done callback.
Sorry, something went wrong.
| .getUser() | ||
| .createRepo({name: testRepoName}) | ||
| .then(wait()) | ||
| .then(wait(5000)) |
There was a problem hiding this comment.
I generally find arbitrary delays like this in tests to be brittle. Perhaps a better solution is to poll for the repo until it comes back successfully.
Sorry, something went wrong.
|
|
||
| ```javascript | ||
| import GitHub from 'github-api'; | ||
| var GitHub = require('github-api'); |
There was a problem hiding this comment.
My opinion is that ECMA2015 is spec now, so there's no need to downgrade.
Sorry, something went wrong.
| const url = this.__getURL(path); | ||
| const headers = this.__getRequestHeaders(raw); | ||
|
|
||
| const AcceptHeader = (data || {}).AcceptHeader; |
There was a problem hiding this comment.
I think @clayreimann is getting at the usage of PascalCasing instead of camelCasing.
Sorry, something went wrong.
| it('should write to repo', function(done) { | ||
| remoteRepo.writeFile('master', fileName, initialText, initialMessage, assertSuccessful(done, function() { | ||
| remoteRepo.getContents('master', fileName, 'raw', assertSuccessful(done, function(err, fileText) { | ||
| wait().then(() => remoteRepo.getContents('master', fileName, 'raw', |
There was a problem hiding this comment.
Why the wait?
Sorry, something went wrong.
There was a problem hiding this comment.
Sometimes the writeFile succeed even though github didn't really create the file yet and the getContents call fails with 404. Wait is there to give time to Github to settle down
Sorry, something went wrong.
There was a problem hiding this comment.
Blind wait's a generally very brittle. Can you pull github for the file and if it doesn't show up within 20 seconds then fail?
Sorry, something went wrong.
There was a problem hiding this comment.
Indeed, I'll see if I can write an easy to use helper. (This can be done in another PR though)
Sorry, something went wrong.
There was a problem hiding this comment.
Agreed, I'm fine with it in another PR as well.
Sorry, something went wrong.
|
For the changelog generation should we have all these commits squashed with the commit message chore: fix tests |
Sorry, something went wrong.
|
There's nothing here that I really object to, @mtscout6 look good to you too? |
Sorry, something went wrong.
|
Just the rebase and squash for the change log generation. If that's still a thing for this repo. |
Sorry, something went wrong.
|
How is the changelog generation working exactly? |
Sorry, something went wrong.
|
Changelog generation is manual
…On Nov 29, 2016, 5:45 PM -0600, Mathieu Dutour ***@***.***>, wrote:
How is the changelog generation working exactly?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub (#401 (comment)), or mute the thread (https://github.com/notifications/unsubscribe-auth/AA4w94TztRRlcNlX7iiIVQ6TgwtIZtIpks5rDLkYgaJpZM4K27nr).
|
Sorry, something went wrong.
|
Very well, I thought it was auto generated from the commit messages. Never mind then this is good to go. |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
That's a lot of changes. Tell me if you are interested, I'll clean the history and the package.json