Skip to content

Commit 3d2b7a9

Browse files
committed
Migrate breaking change "artifact.create" using "new DefaultArtifactClient()"
1 parent fecfb01 commit 3d2b7a9

File tree

7 files changed

+3420
-155
lines changed

7 files changed

+3420
-155
lines changed

github-action-runtime/LICENSE

Lines changed: 3308 additions & 141 deletions
Large diffs are not rendered by default.

github-action-runtime/index.js

Lines changed: 72 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

github-action-runtime/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/manageArtifacts.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ const fs_1 = require("fs");
4646
const core = __importStar(require("@actions/core"));
4747
const config_1 = require("./config");
4848
const rimraf_1 = __importDefault(require("rimraf"));
49-
// eslint-disable-next-line @typescript-eslint/no-var-requires
50-
const artifact = require('@actions/artifact');
49+
const artifact_1 = require("@actions/artifact");
5150
// eslint-disable-next-line @typescript-eslint/no-var-requires
5251
const io = require('@actions/io');
5352
const defineVariableOperation = (variable) => {
@@ -78,10 +77,11 @@ const defineVariableOperation = (variable) => {
7877
}
7978
};
8079
const storeArtifact = (variables, failIfNotFound) => __awaiter(void 0, void 0, void 0, function* () {
81-
const client = artifact.create();
80+
const client = new artifact_1.DefaultArtifactClient();
8281
const artifactOptions = {
8382
retentionDays: 1, // Only keep artifacts 1 day to avoid reach limit: https://github.com/actions/toolkit/blob/c861dd8859fe5294289fcada363ce9bc71e9d260/packages/artifact/src/internal/upload-options.ts#L1
8483
};
84+
// Used to be able to use type "UploadResponse" but it's not exported by the lib in v2 anymore
8585
const artifactsUploadPromises = [];
8686
rimraf_1.default.sync(config_1.WORKDIR);
8787
(0, fs_1.mkdirSync)(config_1.WORKDIR);
@@ -108,12 +108,13 @@ const storeArtifact = (variables, failIfNotFound) => __awaiter(void 0, void 0, v
108108
}
109109
});
110110
const retrieveArtifact = (variables, failIfNotFound) => __awaiter(void 0, void 0, void 0, function* () {
111-
const client = artifact.create();
111+
const client = new artifact_1.DefaultArtifactClient();
112112
rimraf_1.default.sync(config_1.WORKDIR);
113113
(0, fs_1.mkdirSync)(config_1.WORKDIR);
114114
for (const variable of variables) {
115115
try {
116116
const file = (0, path_1.join)(config_1.WORKDIR, `${variable.key}.txt`);
117+
// @ts-ignore
117118
yield client.downloadArtifact(variable.key);
118119
variable.value = (0, fs_1.readFileSync)(file, { encoding: 'utf8' }).toString();
119120
core.exportVariable(variable.key, variable.value);
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
"use strict";
2+
Object.defineProperty(exports, "__esModule", { value: true });
3+
exports.NoFileOptions = exports.Inputs = void 0;
4+
/* eslint-disable no-unused-vars */
5+
var Inputs;
6+
(function (Inputs) {
7+
Inputs["Name"] = "name";
8+
Inputs["Path"] = "path";
9+
Inputs["IfNoFilesFound"] = "if-no-files-found";
10+
Inputs["RetentionDays"] = "retention-days";
11+
Inputs["CompressionLevel"] = "compression-level";
12+
Inputs["Overwrite"] = "overwrite";
13+
Inputs["IncludeHiddenFiles"] = "include-hidden-files";
14+
})(Inputs = exports.Inputs || (exports.Inputs = {}));
15+
var NoFileOptions;
16+
(function (NoFileOptions) {
17+
/**
18+
* Default. Output a warning but do not fail the action
19+
*/
20+
NoFileOptions["warn"] = "warn";
21+
/**
22+
* Fail the action with an error message
23+
*/
24+
NoFileOptions["error"] = "error";
25+
/**
26+
* Do not output any warnings or errors, the action does not fail
27+
*/
28+
NoFileOptions["ignore"] = "ignore";
29+
})(NoFileOptions = exports.NoFileOptions || (exports.NoFileOptions = {}));
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"use strict";
2+
Object.defineProperty(exports, "__esModule", { value: true });

src/manageArtifacts.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ import { WORKDIR } from './config';
1212
import rimraf from 'rimraf';
1313
import { ArtifactClient } from '@actions/artifact';
1414
import { UploadInputs } from './types/upload-artifact/upload-inputs';
15+
import { DefaultArtifactClient} from '@actions/artifact';
1516

16-
// eslint-disable-next-line @typescript-eslint/no-var-requires
17-
const artifact = require('@actions/artifact');
1817
// eslint-disable-next-line @typescript-eslint/no-var-requires
1918
const io = require('@actions/io');
2019

@@ -44,7 +43,7 @@ const defineVariableOperation = (variable: string): VariableStatus => {
4443
};
4544

4645
const storeArtifact = async (variables: VariableDetail[], failIfNotFound: boolean): Promise<void> => {
47-
const client: ArtifactClient = artifact.create();
46+
const client: ArtifactClient = new DefaultArtifactClient();
4847
const artifactOptions: Partial<UploadInputs> = {
4948
retentionDays: 1, // Only keep artifacts 1 day to avoid reach limit: https://github.com/actions/toolkit/blob/c861dd8859fe5294289fcada363ce9bc71e9d260/packages/artifact/src/internal/upload-options.ts#L1
5049
};
@@ -77,7 +76,7 @@ const storeArtifact = async (variables: VariableDetail[], failIfNotFound: boolea
7776
};
7877

7978
const retrieveArtifact = async (variables: VariableDetail[], failIfNotFound: boolean): Promise<void> => {
80-
const client: ArtifactClient = artifact.create();
79+
const client: ArtifactClient = new DefaultArtifactClient();
8180

8281
rimraf.sync(WORKDIR);
8382
mkdirSync(WORKDIR);

0 commit comments

Comments
 (0)