Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow adding the URL of the PR to the release notes #582

Merged
merged 4 commits into from Jul 2, 2020
Merged

Allow adding the URL of the PR to the release notes #582

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
788a740
Add the change template variable URL
b00men Jul 1, 2020
f7c22cb
Update readme to include $URL
b00men Jul 1, 2020
f5d567e
Add a test the PR URL
b00men Jul 1, 2020
4660057
Pull the PR URL only if it is listed in the config
b00men Jul 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Expand Up @@ -169,12 +169,13 @@ If a pull requests is found with the label `major`/`minor`/`patch`, the correspo

You can use any of the following variables in `change-template`:

| Variable | Description |
| --------- | ----------------------------------------------------------- |
| `$NUMBER` | The number of the pull request, e.g. `42`. |
| `$TITLE` | The title of the pull request, e.g. `Add alien technology`. |
| `$AUTHOR` | The pull request author’s username, e.g. `gracehopper`. |
| `$BODY` | The body of the pull request e.g. `Fixed spelling mistake`. |
| Variable | Description |
| --------- | --------------------------------------------------------------------------- |
| `$NUMBER` | The number of the pull request, e.g. `42`. |
| `$TITLE` | The title of the pull request, e.g. `Add alien technology`. |
| `$AUTHOR` | The pull request author’s username, e.g. `gracehopper`. |
| `$BODY` | The body of the pull request e.g. `Fixed spelling mistake`. |
| `$URL` | The URL of the pull request e.g. `https://github.com/octocat/repo/pull/42`. |

## References

Expand Down
1 change: 1 addition & 0 deletions lib/commits.js
View file
Open in desktop
Expand Up @@ -35,6 +35,7 @@ module.exports.findCommitsWithAssociatedPullRequestsQuery = /* GraphQL */ `
nodes {
title
number
url
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we do the same include trick as we did for body? Again to avoid pulling extra data that is not needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

body @include(if: $withPullRequestBody)
author {
login
Expand Down
1 change: 1 addition & 0 deletions lib/releases.js
View file
Open in desktop
Expand Up @@ -163,6 +163,7 @@ const generateChangeLog = (mergedPullRequests, config) => {
$NUMBER: pullRequest.number,
$AUTHOR: pullRequest.author ? pullRequest.author.login : 'ghost',
$BODY: pullRequest.body,
$URL: pullRequest.url,
})
)
.join('\n')
Expand Down
18 changes: 18 additions & 0 deletions test/fixtures/__generated__/graphql-commits-forking.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions test/fixtures/__generated__/graphql-commits-merge-commit.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions test/fixtures/__generated__/graphql-commits-overlapping-label.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.