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

fix: Revert "fix(github): Sanitize mentions in commit bodies (#30842)" #30910

Merged
merged 1 commit into from
Aug 20, 2024
Merged

fix: Revert "fix(github): Sanitize mentions in commit bodies (#30842)" #30910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 0 additions & 35 deletions lib/modules/platform/github/scm.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,39 +73,4 @@ describe('modules/platform/github/scm', () => {
platformCommit: 'auto',
});
});

describe('sanitize mentions in commit messages', () => {
it('single string', async () => {
await githubScm.commitAndPush({
...commitObj,
message: 'Use @octokit to irritate @octocat',
platformCommit: 'enabled',
});

expect(git.commitFiles).not.toHaveBeenCalled();
expect(git.luolix.topmitFiles).toHaveBeenCalledWith({
...commitObj,
message: 'Use @\u{8203}octokit to irritate @\u{8203}octocat',
platformCommit: 'enabled',
});
});

it('array of string', async () => {
await githubScm.commitAndPush({
...commitObj,
message: ['Use @octokit', 'It automates the way we irritate @octocat'],
platformCommit: 'enabled',
});

expect(git.commitFiles).not.toHaveBeenCalled();
expect(git.luolix.topmitFiles).toHaveBeenCalledWith({
...commitObj,
message: [
'Use @\u{8203}octokit',
'It automates the way we irritate @\u{8203}octocat',
],
platformCommit: 'enabled',
});
});
});
});
10 changes: 0 additions & 10 deletions lib/modules/platform/github/scm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
import is from '@sindresorhus/is';
import * as git from '../../../util/git';
import type { CommitFilesConfig, LongCommitSha } from '../../../util/git/types';
import { DefaultGitScm } from '../default-scm';
import { commitFiles, isGHApp } from './';

export function sanitizeMentions(input: string): string {
return input.replaceAll('@', '@\u{8203}');
}

export class GithubScm extends DefaultGitScm {
override commitAndPush(
commitConfig: CommitFilesConfig,
Expand All @@ -17,11 +12,6 @@ export class GithubScm extends DefaultGitScm {
platformCommit = 'enabled';
}

const sanitizedMessage = is.array(commitConfig.message)
? commitConfig.message.map(sanitizeMentions)
: sanitizeMentions(commitConfig.message);
commitConfig.message = sanitizedMessage;

return platformCommit === 'enabled'
? commitFiles(commitConfig)
: git.commitFiles(commitConfig);
Expand Down