Skip to content

Commit

Permalink
feat: github actions logging (#752)
Browse files Browse the repository at this point in the history
Co-authored-by: João Moreno <joao.moreno@microsoft.com>
  • Loading branch information
nhedger and joaomoreno authored Jul 19, 2022
1 parent 7e16ed7 commit 9c50aa6
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions src/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import chalk from 'chalk';
import { PublicGalleryAPI } from './publicgalleryapi';
import { ISecurityRolesApi } from 'azure-devops-node-api/SecurityRolesApi';
import { Manifest } from './manifest';
import { EOL } from 'os';

const __read = promisify<_read.Options, string>(_read);
export function read(prompt: string, options: _read.Options = {}): Promise<string> {
Expand Down Expand Up @@ -129,14 +130,31 @@ function _log(type: LogMessageType, msg: any, ...args: any[]): void {
args = [LogPrefix[type], msg, ...args];

if (type === LogMessageType.WARNING) {
console.warn(...args);
process.env['GITHUB_ACTIONS'] ? logToGitHubActions('warning', msg) : console.warn(...args);
} else if (type === LogMessageType.ERROR) {
console.error(...args);
process.env['GITHUB_ACTIONS'] ? logToGitHubActions('error', msg) : console.error(...args);
} else {
console.log(...args);
process.env['GITHUB_ACTIONS'] ? logToGitHubActions('info', msg) : console.log(...args);
}
}

const EscapeCharacters = new Map([
['%', '%25'],
['\r', '%0D'],
['\n', '%0A'],
]);

const EscapeRegex = new RegExp(`[${[...EscapeCharacters.keys()].join('')}]`, 'g');

function escapeGitHubActionsMessage(message: string): string {
return message.replace(EscapeRegex, c => EscapeCharacters.get(c) ?? c);
}

function logToGitHubActions(type: string, message: string): void {
const command = type === 'info' ? message : `::${type}::${escapeGitHubActionsMessage(message)}`;
process.stdout.write(command + EOL);
}

export interface LogFn {
(msg: any, ...args: any[]): void;
}
Expand Down

0 comments on commit 9c50aa6

Please sign in to comment.