Allow providing a list of characters to escape in PR titles #611

Happypig375 · 2020-08-01T06:41:31Z

Fixes #609

jetersen · 2020-08-01T07:14:05Z

You have not updated the schema. To do so run yarn generate-schema
https://github.com/release-drafter/release-drafter/runs/934759216#step:4:363

jetersen · 2020-08-01T07:27:57Z

README.md

+| Variable  | Description                                                                                                                                                                                                                                 |
+| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `$NUMBER` | The number of the pull request, e.g. `42`.                                                                                                                                                                                                  |
+| `$TITLE`  | The title of the pull request, e.g. `Add alien technology`. Any characters matching `change-title-escapes` will be prepended with a backslash so that they will appear verbatim instead of being interpreted as markdown format characters. |


What about escaping @
There are two options according to github/markup#1168

One using zero-width space or html comment . I think the html comment is better as it is easier to "recreate" not everybody knows how to type a zero-width space.

@jetersen
@jetersen

I like the zero-width space better as it doesn't clutter reading as much. We are auto-generating these lines anyways.

What if user accidentally deletes the line and does not know how to type a zero-width space?

@jetersen @ jetersen

Oops it's a nbsp

Maybe using comments is the way to go then.

You can also do this:
@&ZeroWidthSpace;jetersen @jetersen
@ jetersen @ jetersen

  is not a good option

 @jetersen
⁠ @⁠jetersen
 @jetersen
Comments seem to be the most obvious and short option.

Same trick can be used for #s.

Happypig375 · 2020-08-01T07:35:39Z

I have no idea how to create a test with special PR titles...

jetersen · 2020-08-01T07:41:28Z

I think you can simply write tests that test the function directly. Instead of relying on indirect test workflow.

Happypig375 · 2020-08-01T08:49:45Z

@jetersen PR is ready

lib/releases.js

jetersen · 2020-08-01T09:04:06Z

test/releases.test.js

+      const changelog = generateChangeLog(pullRequests, baseConfig)
+      expect(changelog).toEqual('* A1 (#1) @ghost\n* B2 (#2) @ghost\n* Adds missing <example> (#3) @jetersen\n* `#code_block` (#4) @jetersen\n* Fixes #4 (#5) @Happypig375\n* 2*2 should equal to 4*1 (#6) @jetersen\n* Rename __confgs\\confg.yml to __configs\\config.yml (#7) @ghost\n* Adds @nullable annotations to the 1*1+2*4 test in `tests.java` (#0) @Happypig375')
+    })
+    it('escapes titles with \\s correctly', () => {
+      const config = {
+        ...baseConfig,
+        'change-title-escapes': '\\'
+      }
+      const changelog = generateChangeLog(pullRequests, config)
+      expect(changelog).toEqual('* A1 (#1) @ghost\n* B2 (#2) @ghost\n* Adds missing <example> (#3) @jetersen\n* `#code_block` (#4) @jetersen\n* Fixes #4 (#5) @Happypig375\n* 2*2 should equal to 4*1 (#6) @jetersen\n* Rename __confgs\\\\confg.yml to __configs\\\\config.yml (#7) @ghost\n* Adds @nullable annotations to the 1*1+2*4 test in `tests.java` (#0) @Happypig375')
+    })
+    it('escapes titles with \\<*_& correctly', () => {
+      const config = {
+        ...baseConfig,
+        'change-title-escapes': '\\<*_&'
+      }
+      const changelog = generateChangeLog(pullRequests, config)
+      expect(changelog).toEqual('* A1 (#1) @ghost\n* B2 (#2) @ghost\n* Adds missing \\<example> (#3) @jetersen\n* `#code_block` (#4) @jetersen\n* Fixes #4 (#5) @Happypig375\n* 2\\*2 should equal to 4\\*1 (#6) @jetersen\n* Rename \\_\\_confgs\\\\confg.yml to \\_\\_configs\\\\config.yml (#7) @ghost\n* Adds @nullable annotations to the 1\\*1+2\\*4 test in `tests.java` (#0) @Happypig375')
+    })
+    it('escapes titles with @s correctly', () => {
+      const config = {
+        ...baseConfig,
+        'change-title-escapes': '@'
+      }
+      const changelog = generateChangeLog(pullRequests, config)
+      expect(changelog).toEqual('* A1 (#1) @ghost\n* B2 (#2) @ghost\n* Adds missing <example> (#3) @jetersen\n* `#code_block` (#4) @jetersen\n* Fixes #4 (#5) @Happypig375\n* 2*2 should equal to 4*1 (#6) @jetersen\n* Rename __confgs\\confg.yml to __configs\\config.yml (#7) @ghost\n* Adds @<!---->nullable annotations to the 1*1+2*4 test in `tests.java` (#0) @Happypig375')
+    })
+    it('escapes titles with @s and #s correctly', () => {
+      const config = {
+        ...baseConfig,
+        'change-title-escapes': '@#'
+      }
+      const changelog = generateChangeLog(pullRequests, config)
+      expect(changelog).toEqual('* A1 (#1) @ghost\n* B2 (#2) @ghost\n* Adds missing <example> (#3) @jetersen\n* `#code_block` (#4) @jetersen\n* Fixes #<!---->4 (#5) @Happypig375\n* 2*2 should equal to 4*1 (#6) @jetersen\n* Rename __confgs\\confg.yml to __configs\\config.yml (#7) @ghost\n* Adds @<!---->nullable annotations to the 1*1+2*4 test in `tests.java` (#0) @Happypig375')
+    })
+    it('escapes titles with \\<@*_&`# correctly', () => {
+      const config = {
+        ...baseConfig,
+        'change-title-escapes': '\\<@*_&`#'
+      }
+      const changelog = generateChangeLog(pullRequests, config)
+      expect(changelog).toEqual('* A1 (#1) @ghost\n* B2 (#2) @ghost\n* Adds missing \\<example> (#3) @jetersen\n* \\`#<!---->code\\_block\\` (#4) @jetersen\n* Fixes #<!---->4 (#5) @Happypig375\n* 2\\*2 should equal to 4\\*1 (#6) @jetersen\n* Rename \\_\\_confgs\\\\confg.yml to \\_\\_configs\\\\config.yml (#7) @ghost\n* Adds @<!---->nullable annotations to the 1\\*1+2\\*4 test in \\`tests.java\\` (#0) @Happypig375')


replace toEqual with toMatchInlineSnapshot

Does toMatchInlineSnapshot allow indentation? There is

release-drafter/test/index.test.js

Lines 187 to 202 in 842a9a8

expect(body).toMatchInlineSnapshot(`

Object {

"body": "# What's Changed

* Add documentation (#5) @TimonVS

* Update dependencies (#4) @TimonVS

* Bug fixes (#3) @TimonVS

* Add big feature (#2) @TimonVS

* 👽 Add alien technology (#1) @TimonVS

",

"draft": true,

"name": "",

"prerelease": false,

"tag_name": "",

}

`)

but this PR's tests seem to fail.

Because it is inside a object :)

When you use toMatchInlineSnapshot on a string, it cannot tolerate it 😅

You can also use toMatchSnapshot which will create a file where indentation shouldn't be an issue.

Will wrap it in an object

- Snapshot - 13 + Received + 10 - - Object { - "log": " - * A1 (#1) @ghost - * B2 (#2) @ghost - * Adds missing \<example> (#3) @jetersen - * \`\#code\_block\` (#4) @jetersen - * Fixes #nullable annotations to the 1\*1+2\*4 test in `tests.java` (#0) @Happypig375 - ", - } + Object { + "log": "* A1 (#1) @ghost + * B2 (#2) @ghost + * Adds missing \\<example> (#3) @jetersen + * \\`#code\\_block\\` (#4) @jetersen + * Fixes #4 (#5) @Happypig375 + * 2\\*2 should equal to 4\\*1 (#6) @jetersen + * Rename \\_\\_confgs\\\\confg.yml to \\_\\_configs\\\\config.yml (#7) @ghost + * Adds @nullable annotations to the 1\\*1+2\\*4 test in \\`tests.java\\` (#0) @Happypig375", + }

I'll throw away indentation.

- Snapshot - 0 + Received + 0

???

Trying to use toMatchInlineSnapshot is literally a waste of time.

@jetersen Any suggestions?

jetersen · 2020-08-04T15:34:42Z

I simply did yarn jest --updateSnapshot it's not that hard. Use the lovely tooling people did.

Happypig375 · 2020-08-20T15:37:06Z

@jetersen Are there any more issues to resolve with this PR?

Happypig375 · 2020-08-27T09:16:08Z

ping

Happypig375 added 9 commits August 1, 2020 14:01

Update schema.js

f17c5c5

Update default-config.js

8faac16

Update template.js

dd8e1a0

Update template.js

1b14e17

Update releases.js

ec0dcc6

Update README.md

b14560f

Update schema.test.js

ff7f545

Format tables correctly

3e23e99

Update schema.json

9aebd72

Happypig375 marked this pull request as draft August 1, 2020 06:47

This comment has been minimized.

Sign in to view

Happypig375 added 3 commits August 1, 2020 14:59

Update schema.js

124721e

Revert template.js

54ffe45

Update releases.js

00d48d5

Happypig375 added 5 commits August 1, 2020 15:14

Update schema.json

ba486c5

Create config-with-change-title-escapes.yml

6c73b59

Create config-with-change-title-escapes-backticks.yml

67a3f3d

Update config-with-change-title-escapes.yml

f1e7147

Update config-with-change-title-escapes-backticks.yml

5a3ddc6

jetersen reviewed Aug 1, 2020

View reviewed changes

Update README.md

10448f0

Happypig375 added 6 commits August 1, 2020 15:41

Update README.md

bacd06b

Update releases.js

42eec9b

Update README.md

97f257f

Update releases.js

4a9da5e

Update README.md

84cca5e

Update README.md

aceaae1

Happypig375 added 10 commits August 1, 2020 16:01

Delete config-with-change-title-escapes-backticks.yml

48c5345

Update releases.js

2bdeb98

Create releases.test.js

2549de2

Update releases.test.js

1fc086f

Update releases.test.js

03836a7

Update releases.test.js

87c53ef

Update releases.js

5275a8e

Update releases.test.js

d2a2e9c

Update releases.test.js

d244358

Update releases.test.js

27cd024

Happypig375 marked this pull request as ready for review August 1, 2020 08:48

Update README.md

42869fe

jetersen requested changes Aug 1, 2020

View reviewed changes

Happypig375 and others added 9 commits August 1, 2020 17:06

Update releases.test.js

1580564

Update releases.js

7302f99

Update releases.test.js

f424208

Update releases.test.js

13351ed

Update releases.test.js

0ace598

Update releases.test.js

7c50b8a

Update releases.test.js

36330e9

Update releases.test.js

fac2fe3

yarn jest --updateSnapshot

05cc4ce

yarn lint --fix

c5cec30

jetersen approved these changes Aug 27, 2020

View reviewed changes

jetersen merged commit d472269 into release-drafter:master Aug 27, 2020

jetersen added the type: feature New feature or request label Oct 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow providing a list of characters to escape in PR titles #611

Allow providing a list of characters to escape in PR titles #611

Happypig375 commented Aug 1, 2020 •

edited

This comment has been minimized.

jetersen commented Aug 1, 2020

jetersen Aug 1, 2020

Happypig375 Aug 1, 2020

jetersen Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 Aug 1, 2020

jetersen Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 commented Aug 1, 2020 •

edited

jetersen commented Aug 1, 2020

Happypig375 commented Aug 1, 2020

jetersen Aug 1, 2020

Happypig375 Aug 1, 2020

jetersen Aug 1, 2020 •

edited

jetersen Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 Aug 1, 2020 •

edited

Happypig375 Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 Aug 1, 2020

Happypig375 Aug 4, 2020

jetersen commented Aug 4, 2020

Happypig375 commented Aug 20, 2020

Happypig375 commented Aug 27, 2020

	expect(body).toMatchInlineSnapshot(`
	Object {
	"body": "# What's Changed

	* Add documentation (#5) @TimonVS
	* Update dependencies (#4) @TimonVS
	* Bug fixes (#3) @TimonVS
	* Add big feature (#2) @TimonVS
	* 👽 Add alien technology (#1) @TimonVS
	",
	"draft": true,
	"name": "",
	"prerelease": false,
	"tag_name": "",
	}
	`)

Allow providing a list of characters to escape in PR titles #611

Allow providing a list of characters to escape in PR titles #611

Conversation

Happypig375 commented Aug 1, 2020 • edited

This comment has been minimized.

jetersen commented Aug 1, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Happypig375 commented Aug 1, 2020 • edited

jetersen commented Aug 1, 2020

Happypig375 commented Aug 1, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jetersen Aug 1, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Happypig375 Aug 1, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jetersen commented Aug 4, 2020

Happypig375 commented Aug 20, 2020

Happypig375 commented Aug 27, 2020

Happypig375 commented Aug 1, 2020 •

edited

Happypig375 commented Aug 1, 2020 •

edited

jetersen Aug 1, 2020 •

edited

Happypig375 Aug 1, 2020 •

edited