actions
/
publish-action
mirror of https://github.com/actions/publish-action.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add rc tag

Browse Source
pull/5/head
Varun Sharma 4 years ago
parent 9b5fe1fd8f
commit 5cdf6d60b5
6 changed files with 5853 additions and 153 deletions
Show Stats Download Patch File Download Diff File

6
action.yml
Unescape Escape View File

@ -4,8 +4,10 @@ inputs:
source-tag: source-tag:
description: 'Tag name that the major tag will point to. Examples: v1.2.3, 1.2.3' description: 'Tag name that the major tag will point to. Examples: v1.2.3, 1.2.3'
required: true required: true
slack-webhook: rc:
description: 'Slack Webhook URL to post a message' description: 'Update rc tag'
required: false
default: ''
token: token:
description: 'Token to get an authenticated Octokit' description: 'Token to get an authenticated Octokit'
default: ${{ github.token }} default: ${{ github.token }}

41
dist/index.js vendored
Unescape Escape View File

@ -26,15 +26,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
return result; return result;
}; };
Object.defineProperty(exports, "__esModule", ({ value: true })); Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.postMessageToSlack = exports.updateTag = exports.validateIfReleaseIsPublished = void 0; exports.updateTag = exports.validateIfReleaseIsPublished = void 0;
const core = __importStar(__nccwpck_require__(2186)); const core = __importStar(__nccwpck_require__(2186));
const github_1 = __nccwpck_require__(5438); const github_1 = __nccwpck_require__(5438);
const http_client_1 = __nccwpck_require__(9925);
async function findTag(tag, octokitClient) { async function findTag(tag, octokitClient) {
try { try {
const { data: foundTag } = await octokitClient.git.getRef({ const { data: foundTag } = await octokitClient.git.getRef({
...github_1.context.repo, ...github_1.context.repo,
ref: `tags/${tag}` ref: `tags/${tag}`,
}); });
return foundTag; return foundTag;
} }
@ -84,7 +83,7 @@ async function updateTag(sourceTag, targetTag, octokitClient) {
...github_1.context.repo, ...github_1.context.repo,
ref: refName, ref: refName,
sha: sourceTagSHA, sha: sourceTagSHA,
force: true force: true,
}); });
} }
else { else {
@ -92,17 +91,11 @@ async function updateTag(sourceTag, targetTag, octokitClient) {
await octokitClient.git.createRef({ await octokitClient.git.createRef({
...github_1.context.repo, ...github_1.context.repo,
ref: `refs/${refName}`, ref: `refs/${refName}`,
sha: sourceTagSHA sha: sourceTagSHA,
}); });
} }
} }
exports.updateTag = updateTag; exports.updateTag = updateTag;
async function postMessageToSlack(slackWebhook, message) {
const jsonData = { text: message };
const http = new http_client_1.HttpClient();
await http.postJson(slackWebhook, jsonData);
}
exports.postMessageToSlack = postMessageToSlack;
/***/ }), /***/ }),
@ -134,34 +127,30 @@ var __importStar = (this && this.__importStar) || function (mod) {
Object.defineProperty(exports, "__esModule", ({ value: true })); Object.defineProperty(exports, "__esModule", ({ value: true }));
const core = __importStar(__nccwpck_require__(2186)); const core = __importStar(__nccwpck_require__(2186));
const github = __importStar(__nccwpck_require__(5438)); const github = __importStar(__nccwpck_require__(5438));
const github_1 = __nccwpck_require__(5438);
const api_utils_1 = __nccwpck_require__(2430); const api_utils_1 = __nccwpck_require__(2430);
const version_utils_1 = __nccwpck_require__(1534); const version_utils_1 = __nccwpck_require__(1534);
async function run() { async function run() {
try { try {
const token = core.getInput('token'); const token = core.getInput("token");
const octokitClient = github.getOctokit(token); const octokitClient = github.getOctokit(token);
const sourceTagName = core.getInput('source-tag'); const sourceTagName = core.getInput("source-tag");
const rc = core.getInput("rc");
if (rc !== "") {
await api_utils_1.updateTag(sourceTagName, "rc", octokitClient);
core.setOutput("major-tag", "rc");
core.info(`'rc' tag now points to the '${sourceTagName}' tag`);
}
else {
version_utils_1.validateSemverVersionFromTag(sourceTagName); version_utils_1.validateSemverVersionFromTag(sourceTagName);
await api_utils_1.validateIfReleaseIsPublished(sourceTagName, octokitClient); await api_utils_1.validateIfReleaseIsPublished(sourceTagName, octokitClient);
const majorTag = version_utils_1.getMajorTagFromFullTag(sourceTagName); const majorTag = version_utils_1.getMajorTagFromFullTag(sourceTagName);
await api_utils_1.updateTag(sourceTagName, majorTag, octokitClient); await api_utils_1.updateTag(sourceTagName, majorTag, octokitClient);
core.setOutput('major-tag', majorTag); core.setOutput("major-tag", majorTag);
core.info(`The '${majorTag}' major tag now points to the '${sourceTagName}' tag`); core.info(`The '${majorTag}' major tag now points to the '${sourceTagName}' tag`);
const slackMessage = `The ${majorTag} tag has been successfully updated for the ${github_1.context.repo.repo} action to include changes from the ${sourceTagName}`; }
await reportStatusToSlack(slackMessage);
} }
catch (error) { catch (error) {
core.setFailed(error.message); core.setFailed(error.message);
const slackMessage = `Failed to update a major tag for the ${github_1.context.repo.repo} action`;
await reportStatusToSlack(slackMessage);
}
}
;
async function reportStatusToSlack(message) {
const slackWebhook = core.getInput('slack-webhook');
if (slackWebhook) {
await api_utils_1.postMessageToSlack(slackWebhook, message);
} }
} }
run(); run();

5721
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

4
package.json
Unescape Escape View File

@ -1,6 +1,6 @@
{ {
"name": "publish-action", "name": "publish-action",
"version": "0.1.0", "version": "0.2.0",
"description": "Update the major version tag (v1, v2, etc.) to point to the specified tag", "description": "Update the major version tag (v1, v2, etc.) to point to the specified tag",
"main": "lib/main.js", "main": "lib/main.js",
"scripts": { "scripts": {
@ -23,8 +23,8 @@
"homepage": "https://github.com/actions/publish-action#readme", "homepage": "https://github.com/actions/publish-action#readme",
"dependencies": { "dependencies": {
"@actions/core": "^1.2.7", "@actions/core": "^1.2.7",
"@actions/http-client": "^1.0.11",
"@actions/github": "^4.0.0", "@actions/github": "^4.0.0",
"@actions/http-client": "^1.0.11",
"semver": "^7.3.5" "semver": "^7.3.5"
}, },
"devDependencies": { "devDependencies": {

31
src/api-utils.ts
Unescape Escape View File

@ -1,7 +1,6 @@
import * as core from '@actions/core'; import * as core from "@actions/core";
import { context } from '@actions/github'; import { context } from "@actions/github";
import { GitHub } from '@actions/github/lib/utils'; import { GitHub } from "@actions/github/lib/utils";
import { HttpClient } from '@actions/http-client';
interface GitRef { interface GitRef {
ref: string; ref: string;
@ -21,7 +20,7 @@ async function findTag(
try { try {
const { data: foundTag } = await octokitClient.git.getRef({ const { data: foundTag } = await octokitClient.git.getRef({
...context.repo, ...context.repo,
ref: `tags/${tag}` ref: `tags/${tag}`,
}); });
return foundTag; return foundTag;
@ -42,9 +41,7 @@ async function getTagSHA(
): Promise<string> { ): Promise<string> {
const foundTag = await findTag(tag, octokitClient); const foundTag = await findTag(tag, octokitClient);
if (!foundTag) { if (!foundTag) {
throw new Error( throw new Error(`The '${tag}' tag does not exist in the remote repository`);
`The '${tag}' tag does not exist in the remote repository`
);
} }
return foundTag.object.sha; return foundTag.object.sha;
@ -67,9 +64,7 @@ export async function validateIfReleaseIsPublished(
} }
} catch (err) { } catch (err) {
if (err.status === 404) { if (err.status === 404) {
throw new Error( throw new Error(`No GitHub release found for the ${tag} tag`);
`No GitHub release found for the ${tag} tag`
);
} else { } else {
throw new Error( throw new Error(
`Retrieving releases failed with the following error: ${err}` `Retrieving releases failed with the following error: ${err}`
@ -88,13 +83,15 @@ export async function updateTag(
const refName = `tags/${targetTag}`; const refName = `tags/${targetTag}`;
if (foundTargetTag) { if (foundTargetTag) {
core.info(`Updating the '${targetTag}' tag to point to the '${sourceTag}' tag`); core.info(
`Updating the '${targetTag}' tag to point to the '${sourceTag}' tag`
);
await octokitClient.git.updateRef({ await octokitClient.git.updateRef({
...context.repo, ...context.repo,
ref: refName, ref: refName,
sha: sourceTagSHA, sha: sourceTagSHA,
force: true force: true,
}); });
} else { } else {
core.info(`Creating the '${targetTag}' tag from the '${sourceTag}' tag`); core.info(`Creating the '${targetTag}' tag from the '${sourceTag}' tag`);
@ -102,13 +99,7 @@ export async function updateTag(
await octokitClient.git.createRef({ await octokitClient.git.createRef({
...context.repo, ...context.repo,
ref: `refs/${refName}`, ref: `refs/${refName}`,
sha: sourceTagSHA sha: sourceTagSHA,
}); });
} }
} }
export async function postMessageToSlack(slackWebhook: string, message: string): Promise<void> {
const jsonData = {text: message}
const http = new HttpClient();
await http.postJson(slackWebhook, jsonData);
}

43
src/main.ts
Unescape Escape View File

@ -1,15 +1,24 @@
import * as core from '@actions/core'; import * as core from "@actions/core";
import * as github from '@actions/github'; import * as github from "@actions/github";
import { context } from '@actions/github'; import { updateTag, validateIfReleaseIsPublished } from "./api-utils";
import { updateTag, validateIfReleaseIsPublished, postMessageToSlack } from './api-utils'; import {
import { validateSemverVersionFromTag, getMajorTagFromFullTag } from './version-utils'; validateSemverVersionFromTag,
getMajorTagFromFullTag,
} from "./version-utils";
async function run(): Promise<void> { async function run(): Promise<void> {
try { try {
const token = core.getInput('token'); const token = core.getInput("token");
const octokitClient = github.getOctokit(token); const octokitClient = github.getOctokit(token);
const sourceTagName = core.getInput('source-tag'); const sourceTagName = core.getInput("source-tag");
const rc = core.getInput("rc");
if (rc !== "") {
await updateTag(sourceTagName, "rc", octokitClient);
core.setOutput("major-tag", "rc");
core.info(`'rc' tag now points to the '${sourceTagName}' tag`);
} else {
validateSemverVersionFromTag(sourceTagName); validateSemverVersionFromTag(sourceTagName);
await validateIfReleaseIsPublished(sourceTagName, octokitClient); await validateIfReleaseIsPublished(sourceTagName, octokitClient);
@ -17,23 +26,13 @@ async function run(): Promise<void> {
const majorTag = getMajorTagFromFullTag(sourceTagName); const majorTag = getMajorTagFromFullTag(sourceTagName);
await updateTag(sourceTagName, majorTag, octokitClient); await updateTag(sourceTagName, majorTag, octokitClient);
core.setOutput('major-tag', majorTag); core.setOutput("major-tag", majorTag);
core.info(`The '${majorTag}' major tag now points to the '${sourceTagName}' tag`); core.info(
`The '${majorTag}' major tag now points to the '${sourceTagName}' tag`
const slackMessage = `The ${majorTag} tag has been successfully updated for the ${context.repo.repo} action to include changes from the ${sourceTagName}`; );
await reportStatusToSlack(slackMessage); }
} catch (error) { } catch (error) {
core.setFailed(error.message); core.setFailed(error.message);
const slackMessage = `Failed to update a major tag for the ${context.repo.repo} action`;
await reportStatusToSlack(slackMessage);
}
};
async function reportStatusToSlack(message: string): Promise<void> {
const slackWebhook = core.getInput('slack-webhook');
if (slackWebhook) {
await postMessageToSlack(slackWebhook, message);
} }
} }

Write Preview
Loading…
Cancel
Save