projen
Version:
CDK for software projects
89 lines • 11.7 kB
JavaScript
;
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.GithubCredentials = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
const Case = require("case");
/**
* Represents a method of providing GitHub API access for projen workflows.
*/
class GithubCredentials {
/**
* Provide API access through a GitHub personal access token.
*
* The token must be added as a secret to the GitHub repo, and the name of the
* secret can be specified here.
*
* @see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
* @default - a secret named "PROJEN_GITHUB_TOKEN"
*/
static fromPersonalAccessToken(options = {}) {
return new GithubCredentials({
setupSteps: [],
tokenRef: `\${{ secrets.${options.secret ?? "PROJEN_GITHUB_TOKEN"} }}`,
});
}
/**
* Provide API access through a GitHub App.
*
* The GitHub App must be installed on the GitHub repo, its App ID and a
* private key must be added as secrets to the repo. The name of the secrets
* can be specified here.
*
* @see https://docs.github.com/en/developers/apps/building-github-apps/creating-a-github-app
* @see https://projen.io/docs/integrations/github/#github-app
* @default - app id stored in "PROJEN_APP_ID" and private key stored in "PROJEN_APP_PRIVATE_KEY" with all permissions attached to the app
*/
static fromApp(options = {}) {
const appIdSecret = options.appIdSecret ?? "PROJEN_APP_ID";
const privateKeySecret = options.privateKeySecret ?? "PROJEN_APP_PRIVATE_KEY";
const actionConfig = {
"app-id": `\${{ secrets.${appIdSecret} }}`,
"private-key": `\${{ secrets.${privateKeySecret} }}`,
};
if (options.owner) {
actionConfig.owner = options.owner;
}
if (options.repositories) {
actionConfig.repositories = options.repositories.join(",");
}
const permissions = Object.entries(options.permissions ?? {}).reduce((map, [name, val]) => {
map[`permission-${Case.kebab(name)}`] = val;
return map;
}, {});
return new GithubCredentials({
setupSteps: [
{
name: "Generate token",
id: "generate_token",
uses: "actions/create-github-app-token@3ff1caaa28b64c9cc276ce0a02e2ff584f3900c5",
with: {
...actionConfig,
...permissions,
},
},
],
tokenRef: "${{ steps.generate_token.outputs.token }}",
});
}
constructor(options) {
this.options = options;
}
/**
* Setup steps to obtain GitHub credentials.
*/
get setupSteps() {
return [...this.options.setupSteps];
}
/**
* The value to use in a workflow when a GitHub token is expected. This
* typically looks like "${{ some.path.to.a.value }}".
*/
get tokenRef() {
return this.options.tokenRef;
}
}
exports.GithubCredentials = GithubCredentials;
_a = JSII_RTTI_SYMBOL_1;
GithubCredentials[_a] = { fqn: "projen.github.GithubCredentials", version: "0.95.2" };
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"github-credentials.js","sourceRoot":"","sources":["../../src/github/github-credentials.ts"],"names":[],"mappings":";;;;;AAAA,6BAA6B;AAqD7B;;GAEG;AACH,MAAa,iBAAiB;IAC5B;;;;;;;;OAQG;IACI,MAAM,CAAC,uBAAuB,CACnC,UAAuD,EAAE;QAEzD,OAAO,IAAI,iBAAiB,CAAC;YAC3B,UAAU,EAAE,EAAE;YACd,QAAQ,EAAE,gBAAgB,OAAO,CAAC,MAAM,IAAI,qBAAqB,KAAK;SACvE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,OAAO,CAAC,UAAuC,EAAE;QAC7D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,eAAe,CAAC;QAC3D,MAAM,gBAAgB,GACpB,OAAO,CAAC,gBAAgB,IAAI,wBAAwB,CAAC;QAEvD,MAAM,YAAY,GAA2B;YAC3C,QAAQ,EAAE,gBAAgB,WAAW,KAAK;YAC1C,aAAa,EAAE,gBAAgB,gBAAgB,KAAK;SACrD,CAAC;QAEF,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,YAAY,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QACrC,CAAC;QACD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACzB,YAAY,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,MAAM,CAElE,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE;YACrB,GAAG,CAAC,cAAc,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO,IAAI,iBAAiB,CAAC;YAC3B,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,gBAAgB;oBACtB,EAAE,EAAE,gBAAgB;oBACpB,IAAI,EAAE,0EAA0E;oBAChF,IAAI,EAAE;wBACJ,GAAG,YAAY;wBACf,GAAG,WAAW;qBACf;iBACF;aACF;YACD,QAAQ,EAAE,2CAA2C;SACtD,CAAC,CAAC;IACL,CAAC;IAED,YAAqC,OAAiC;QAAjC,YAAO,GAAP,OAAO,CAA0B;IAAG,CAAC;IAE1E;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;;AArFH,8CAsFC","sourcesContent":["import * as Case from \"case\";\nimport { JobStep, AppPermissions } from \"./workflows-model\";\n\n/**\n * Options for `GithubCredentials.fromPersonalAccessToken`\n */\nexport interface GithubCredentialsPersonalAccessTokenOptions {\n  readonly secret?: string;\n}\n\n/**\n * Options for `GithubCredentials.fromApp`\n */\nexport interface GithubCredentialsAppOptions {\n  /**\n   * The secret containing the GitHub App ID\n   *\n   * @default \"PROJEN_APP_ID\"\n   */\n  readonly appIdSecret?: string;\n\n  /**\n   * The secret containing the GitHub App private key\n   *\n   * Escaped newlines (\\\\n) will be automatically replaced with actual newlines.\n   *\n   * @default \"PROJEN_APP_PRIVATE_KEY\"\n   */\n  readonly privateKeySecret?: string;\n\n  /**\n   * The owner of the GitHub App installation\n   *\n   * @default - if empty, defaults to the current repository owner\n   */\n  readonly owner?: string;\n\n  /**\n   * List of repositories to grant access to\n   *\n   * @default - if owner is set and repositories is empty, access will be scoped to all repositories in the provided repository owner's installation.\n   * If owner and repositories are empty, access will be scoped to only the current repository.\n   */\n  readonly repositories?: string[];\n\n  /**\n   * The permissions granted to the token.\n   *\n   * @default - all permissions granted to the app\n   */\n  readonly permissions?: AppPermissions;\n}\n\n/**\n * Represents a method of providing GitHub API access for projen workflows.\n */\nexport class GithubCredentials {\n  /**\n   * Provide API access through a GitHub personal access token.\n   *\n   * The token must be added as a secret to the GitHub repo, and the name of the\n   * secret can be specified here.\n   *\n   * @see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n   * @default - a secret named \"PROJEN_GITHUB_TOKEN\"\n   */\n  public static fromPersonalAccessToken(\n    options: GithubCredentialsPersonalAccessTokenOptions = {}\n  ) {\n    return new GithubCredentials({\n      setupSteps: [],\n      tokenRef: `\\${{ secrets.${options.secret ?? \"PROJEN_GITHUB_TOKEN\"} }}`,\n    });\n  }\n\n  /**\n   * Provide API access through a GitHub App.\n   *\n   * The GitHub App must be installed on the GitHub repo, its App ID and a\n   * private key must be added as secrets to the repo. The name of the secrets\n   * can be specified here.\n   *\n   * @see https://docs.github.com/en/developers/apps/building-github-apps/creating-a-github-app\n   * @see https://projen.io/docs/integrations/github/#github-app\n   * @default - app id stored in \"PROJEN_APP_ID\" and private key stored in \"PROJEN_APP_PRIVATE_KEY\" with all permissions attached to the app\n   */\n  public static fromApp(options: GithubCredentialsAppOptions = {}) {\n    const appIdSecret = options.appIdSecret ?? \"PROJEN_APP_ID\";\n    const privateKeySecret =\n      options.privateKeySecret ?? \"PROJEN_APP_PRIVATE_KEY\";\n\n    const actionConfig: Record<string, string> = {\n      \"app-id\": `\\${{ secrets.${appIdSecret} }}`,\n      \"private-key\": `\\${{ secrets.${privateKeySecret} }}`,\n    };\n\n    if (options.owner) {\n      actionConfig.owner = options.owner;\n    }\n    if (options.repositories) {\n      actionConfig.repositories = options.repositories.join(\",\");\n    }\n\n    const permissions = Object.entries(options.permissions ?? {}).reduce<\n      Record<string, string>\n    >((map, [name, val]) => {\n      map[`permission-${Case.kebab(name)}`] = val;\n      return map;\n    }, {});\n\n    return new GithubCredentials({\n      setupSteps: [\n        {\n          name: \"Generate token\",\n          id: \"generate_token\",\n          uses: \"actions/create-github-app-token@3ff1caaa28b64c9cc276ce0a02e2ff584f3900c5\",\n          with: {\n            ...actionConfig,\n            ...permissions,\n          },\n        },\n      ],\n      tokenRef: \"${{ steps.generate_token.outputs.token }}\",\n    });\n  }\n\n  private constructor(private readonly options: GithubCredentialsOptions) {}\n\n  /**\n   * Setup steps to obtain GitHub credentials.\n   */\n  public get setupSteps(): JobStep[] {\n    return [...this.options.setupSteps];\n  }\n\n  /**\n   * The value to use in a workflow when a GitHub token is expected. This\n   * typically looks like \"${{ some.path.to.a.value }}\".\n   */\n  public get tokenRef(): string {\n    return this.options.tokenRef;\n  }\n}\n\ninterface GithubCredentialsOptions {\n  readonly setupSteps: JobStep[];\n  readonly tokenRef: string;\n}\n"]}