features: host override, dynamic pull and commit msg body #41

shcarrico · 2019-01-10T03:41:05Z

This is a somewhat opinionated pull. 😺

TLDR, this makes it possible to run just santari --token your_token. (You can also still use environment variable as before). All other required info is derived from your projects package.json by default.

It also creates dynamic PR and commit messages by using a diff of the existing vs updated dependency lists.

read repo / host from package.json if not specified
- will read package.json and parse out the github host, repository by default
- can also add repo to your config file, or specify on cli as before
accept api token on cli as --token as well as GITHUB_KEY environment variable
will attempt to read a local .santari.json without specifying via --config, -c first, then will look for argument path
merges config file props with cli so props can be specified similarly
- defaults are picked first (mostly null except for the GITHUB_KEY env variable, then config file props, then cli args to allow for override, ie, the CLI arguments always win, then config file, then environment var.
accept command line or config file arguments for similar props
- updated cli yargs to follow convention for aliases and work similarly for all props by adding aliases and using .option call
generates pull request body and commit message body dynamically based on diff of what was updated
documentation updates to match above
relaxes a few onerous eslint rules

example commit message:

 chore(package.json): update dependencies

Dev dependencies updated:
* `@types/jasmine : ^3.3.4 -> ^3.3.5`
* `@types/node : ^10.12.12 -> ^10.12.18`

example pull request body:

Dev dependencies updated:

    @types/jasmine : ^3.3.4 -> ^3.3.5
    @types/node : ^10.12.12 -> ^10.12.18

* read repo / host from package.json if not specified * accept command line or config file arguments for similar props * generates pull request body and commit message body dynamically based on diff of what was updated * documentation updates to match above

jeremyrajan · 2019-01-10T09:03:42Z

Thanks for the PR @shcarrico 😄 . I was actually planning on adding messages in the PR body, since you did it, its wonderful 🎉 . I will give it a shot later today and merge it! I don't think there is a breaking change right? I was thinking to bump the version to 2.6.0.

jeremyrajan · 2019-01-21T15:55:45Z

hey @shcarrico, apologies in delay in going thru this. Everything looks good, except few changes I put in comments :). I tried to update it, but dont have access to the repo you are PR'ing from. Would be nice you can update and I can merge 🎉 and also resolve conflicts 👼

jeremyrajan · 2019-01-21T15:53:38Z

src/libs/utils.js

+    if (pkg) {
+      const pkgRepo = pkg.repository.url || pkg.repository;
+      const pkgGit = gitUrl(pkgRepo);
+      host = `${pkgGit.host}/api/v3`;


I dont think, we need to override it. Because normally the API path should be api.github.com, unless you setup the host in .santari.json.

I was trying to match the api path with the supported api version for the client.. normally, this is done for you because you don't supply the host, but in this case if you do supply it i need it with the /api/v3 to work in the later call to github.client(config.token, { hostname: config.host }). The host is being read from the package.json repository settings here, specifically so you don't have to override it in .santari.json. this may be confusing because I am both loading package.json and .santari.json in the same function..

jeremyrajan · 2019-01-21T15:54:23Z

.santari.json

+    "title": "PR title",
+    "body": "PR Body"


We can remove title and body from demo config :). Atleast we can show the pr body being populated.

jeremyrajan · 2019-01-21T15:56:26Z

Example here: jeremyrajan/json-markdown#23

jeremyrajan · 2019-01-21T15:58:21Z

src/tasks/santari.js

    this.masterSHA = ''; // master SHA
    this.packageSHA = ''; // package JSON SHA
    this.packagePath = ''; // package path from repo
    this.packageJSON = ''; // JSON parsed version of repo package
    this.packageTempPath = ''; // package path where temp package is stored. To be used by ncu
    this.depBranchName = `update-deps-santari-${Math.ceil(Math.random() * 100000)}`;
-    this.mainBranch = 'master';
+    this.mainBranch = config.branch || 'master';
+    this.commitMsg = config.msg || 'chore(package.json): update dependencies\n';


May be we can use a different key, like commitMessage instead of msg ?

shcarrico · 2019-01-23T06:20:23Z

I will get on this tomorrow!

jeremyrajan · 2019-02-02T05:03:38Z

@shcarrico did you get some time to update this? :)

Stan Carrico added 4 commits January 9, 2019 18:23

chore(eslint): relax eslint rules

352c1b4

chore(.santari.json): update example config file

f808df4

2.6.0-0

bbad03d

jeremyrajan self-requested a review January 10, 2019 09:04

Stan Carrico added 2 commits January 16, 2019 14:39

feature(config): allow branch name override

0b0c35a

2.6.0

c11e2d0

jeremyrajan requested changes Jan 21, 2019

View reviewed changes

jeremyrajan reviewed Jan 21, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

features: host override, dynamic pull and commit msg body #41

features: host override, dynamic pull and commit msg body #41

shcarrico commented Jan 10, 2019

jeremyrajan commented Jan 10, 2019 •

edited

Loading

jeremyrajan commented Jan 21, 2019

jeremyrajan Jan 21, 2019

shcarrico Jan 23, 2019

jeremyrajan Jan 21, 2019

jeremyrajan commented Jan 21, 2019

jeremyrajan Jan 21, 2019 •

edited

Loading

shcarrico commented Jan 23, 2019

jeremyrajan commented Feb 2, 2019

features: host override, dynamic pull and commit msg body #41

Are you sure you want to change the base?

features: host override, dynamic pull and commit msg body #41

Conversation

shcarrico commented Jan 10, 2019

jeremyrajan commented Jan 10, 2019 • edited Loading

jeremyrajan commented Jan 21, 2019

jeremyrajan Jan 21, 2019

Choose a reason for hiding this comment

shcarrico Jan 23, 2019

Choose a reason for hiding this comment

jeremyrajan Jan 21, 2019

Choose a reason for hiding this comment

jeremyrajan commented Jan 21, 2019

jeremyrajan Jan 21, 2019 • edited Loading

Choose a reason for hiding this comment

shcarrico commented Jan 23, 2019

jeremyrajan commented Feb 2, 2019

jeremyrajan commented Jan 10, 2019 •

edited

Loading

jeremyrajan Jan 21, 2019 •

edited

Loading