feat: several Git2Gus improvements. See the details in description. by jag-j · Pull Request #62 · forcedotcom/git2gus

jag-j · 2020-04-16T14:35:20Z

Show github issue link in the description of the created GUS work item (W-7251050 (https://gus.my.salesforce.com/a07B00000087CpBIAU))
Prepend a custom-text to the subject line of issues (W-7387696 (https://gus.my.salesforce.com/a07B0000008BGDZIA4))
Do not post created GUS work item as a comment, but rather update the initial comment (W-7251060 (https://gus.my.salesforce.com/a07B00000087CpVIAU))
Fix description formatting for newly created work items (W-7251029 (https://gus.my.salesforce.com/a07B00000087Co8IAE))
Show GUS work item as a hyperlink.

…Prepend custom text in subject line

…adding comments

…fore creating GUS work

…ssue

jag-j · 2020-04-16T14:45:21Z

api/actions/__test__/createWorkItem.spec.js

            url: 'github/git2gus-test/#30',
            title: 'new issue',
-            body: 'some description',
+            body: '### some title\nsome description',


Test to make sure we process markdown.

jag-j · 2020-04-16T14:46:09Z

api/actions/__test__/createWorkItem.spec.js

+};
+
 describe('createGusItem action', () => {
-    it('should call queue push with the right values', async () => {


Felt this was a redundant test. Changed it to make sure we process we strip down markdown to GUS formatting.

jag-j · 2020-04-16T14:46:21Z

api/actions/__test__/createWorkItem.spec.js

            req,
            body:
-                'Sorry we could wait until Heroku connect make the syncronization.'
+                'Sorry we could wait until Heroku connect make the synchronization.'


Fixed a typo.

is this message saying we could not wait until heroku connect could make the syncronization? or that we had to wait until heroku connect could make the synchronization?

Good point! I should be "could not". @reiniergs - thoughts ?

jag-j · 2020-04-16T14:47:41Z

api/actions/createWorkItem.js

        } = req.body;
        const { config } = req.git2gus;
        const { hideWorkItemUrl } = config;
+        const { suppressGithubComments } = config;


This config to suppress commenting on Github issues, but rather update the description instead. Prevents constant messaging to external customers when they cannot act on those.

this is cool

jag-j · 2020-04-16T14:48:23Z

api/actions/createWorkItem.js

 };
+function formatToGus(url, body) {
+    var formattedDescription;
+    remark().use(markdown).use(strip).process(body, (err, file) => {


Strip markdown to GUS format

This show how this works and I tried with a few github issues from the past and seems to work as expected - http://remarkjs.github.io/strip-markdown/

jag-j · 2020-04-16T14:49:18Z

api/actions/createWorkItem.js

+        if (err) {
+            throw err;
+        }
+        formattedDescription = 'Github issue link: '.concat(url, '\n', String(file));


Adds the github link at the top of the description. We can make it a table as @reiniergs suggested. But will involve more work and I can take that up after finishing up the changelist sync story I'm currently working.

jag-j · 2020-04-16T14:51:02Z

api/services/Issues/__test__/getWorkItemUrl.spec.js

        });
        expect(workItemUrl).toBe(
-            'https://gus.lightning.force.com/lightning/r/ADM_Work__c/qwerty1234/view'
+            '[W-234123](https://gus.lightning.force.com/lightning/r/ADM_Work__c/qwerty1234/view)'


Just a nice a have feature to show linked GUS item as a hyperlink instead of the full URL.

lcampos · 2020-04-16T15:50:27Z

api/actions/createWorkItem.js

+}
+
+async function updateIssue(req, body, suppressGithubComments) {
+    if (suppressGithubComments) {


Shouldn't this method run updateDescription or createComment depending on suppressGithubComments's value ?

Yes, that's the intention. It seems to work since suppressGithubComments config is boolean and not a string or is it a better practice to explicitly check the value?

reiniergs · 2020-04-16T16:04:50Z

api/actions/createWorkItem.js

-            issue: { labels, url, title, body, milestone }
+            issue: { labels, url, body, milestone }
+        } = req.body;
+        var {


use let here instead of var or I will rather compute a new variable like normalizedTitle and avoid doing mutation

reiniergs · 2020-04-16T16:08:34Z

api/actions/createWorkItem.js

        return null;
    }
 };
+function formatToGus(url, body) {


please move this function into separate files

reiniergs · 2020-04-16T16:09:25Z

api/actions/createWorkItem.js

+    return formattedDescription;
+}
+
+async function updateIssue(req, body, suppressGithubComments) {


move helper function into separate files

reiniergs · 2020-04-16T16:17:48Z

api/actions/createWorkItem.js

+
+async function updateIssue(req, body, suppressGithubComments) {
+    if (suppressGithubComments) {
+        return await Github.updateDescription({


if suppressGithubComments is true we shouldn't write the comments in the description of the issue, it will be hard to keep in sync/updated the description moving forward. I will say supressGithubComments suppress any communication back to Github

Let me bring this up with my PM who initially suggested this. FYI @ntotten @smaddox-sf

…ng the updates to description

reiniergs

+1

jag-j added 7 commits April 14, 2020 11:45

@W-7251050@ @W-7387696@ Show github issues link in GUS description + …

38f7210

…Prepend custom text in subject line

@W-7251060@ Provide an option to update issue description instead of …

4826a3f

…adding comments

@W-7251060@ Provide an option to update issue description - Adding tests

076fd84

@W-7251086@ Add GUS work item as an hyperlink to the Github issue

f2e52cf

@W-7251029@ Strip down markdown format of github issue description be…

b1f4ea0

…fore creating GUS work

@W-7387696@ Changing the optional prefix config name

0a61b61

@W-7251060@ Changing the config name to suppress comments on Github i…

29395af

…ssue

jag-j commented Apr 16, 2020

View reviewed changes

lcampos reviewed Apr 16, 2020

View reviewed changes

reiniergs reviewed Apr 16, 2020

View reviewed changes

jag-j force-pushed the master branch from 0e2f85d to 29395af Compare April 22, 2020 14:17

jag-j added 2 commits April 22, 2020 07:28

Updated Yarn lockfile

8b3699e

@W-7251867@ Fixing code review comments - some refactoring and removi…

06f3d7e

…ng the updates to description

reiniergs approved these changes Apr 23, 2020

View reviewed changes

reiniergs changed the title ~~Several Git2Gus improvements. See the details in description.~~ feat: several Git2Gus improvements. See the details in description. Apr 23, 2020

reiniergs merged commit 69c0aee into forcedotcom:master Apr 23, 2020

edmorley mentioned this pull request Aug 1, 2020

Document gusTitlePrefix option #80

Open

Conversation

jag-j commented Apr 16, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnanyaJha Apr 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jag-j Apr 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reiniergs Apr 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reiniergs Apr 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reiniergs left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AnanyaJha Apr 16, 2020 •

edited

Loading

jag-j Apr 16, 2020 •

edited

Loading

reiniergs Apr 16, 2020 •

edited

Loading

reiniergs Apr 16, 2020 •

edited

Loading