Skip to content

ref: Add comments for changelog extraction #289

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

Merged
BYK merged 3 commits into from
Sep 17, 2021
Merged

ref: Add comments for changelog extraction #289

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17c1508
ref: Add comments for changelog extraction
BYK Sep 17, 2021
d6e311d
Use proper English thanks to Chad lol
BYK Sep 17, 2021
2c63476
Clarify symmetrical option comment
BYK Sep 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/utils/git.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ export interface GitChange {
pr: string | null;
}

// This regex relies on the default GitHub behavior where it appends the PR
// number to the end of the commit title as: `fix: Commit title (#123)`.
// This makes it very cheap and quick to extract the associated PR number just
// from the commit log locally.
// If this fails at some future, we can always revert back to using the GitHub
// API that gives you the PRs associated with a commit: https://git.io/JzUVK
export const PRExtractor = /(?<=\(#)\d+(?=\)$)/;

export async function getDefaultBranch(
Expand Down Expand Up @@ -37,6 +43,12 @@ export async function getChangesSince(
const { all: commits } = await git.log({
from: rev,
to: 'HEAD',
// The symmetric option defaults to true, giving us all the different commits
// reachable from both `from` and `to` whereas what we are interested in is only the ones
// reachable from `to` and _not_ from `from` so we get a "changelog" kind of list.
// One is `A - B` and the other is more like `A XOR B`. We want `A - B`.
// See https://github.com/steveukx/git-js#git-log and
// https://git-scm.com/docs/gitrevisions#_dotted_range_notations for more
symmetric: false,
'--no-merges': null,
});
Expand Down