generate README.md from action.yml

ygpark80 · Nov 21, 2023 · 2700669 · 2700669
1 parent d95383a
commit 2700669
Show file tree

Hide file tree

Showing 9 changed files with 408 additions and 183 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,19 @@
 
 This action creates `~/.aws/credentials` file for use in subsequent steps in a GitHub Action workflow.
 
-## Example usage
+## Usage
+
+See [action.yml](action.yml)
 
 ```yaml
-uses: ygpark80/[email protected]
-with:
-  profile: user1
-  aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-  aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-  aws-region: us-east-2
+- uses: ygpark80/[email protected]
+  with:
+    # AWS profile name.
+    profile: ''
+    # AWS Region, e.g. us-east-2
+    aws-region: ''
+    # AWS Access Key ID.
+    aws-access-key-id: ''
+    # AWS Secret Access Key.
+    aws-secret-access-key: ''
 ```
diff --git a/action.yml b/action.yml
@@ -1,13 +1,13 @@
 
 name: Create '~/.aws/credentials' file Action for GitHub Actions
-description: Creates '~/.aws/credentials' file for use in subsequent steps in a GitHub Action workflow
+description: Creates `~/.aws/credentials` file for use in subsequent steps in a GitHub Action workflow
 runs:
   using: node20
   main: dist/index.js
   post: dist/cleanup/index.js
 inputs:
   profile:
-    description: AWS profile name to use in the credentials file.
+    description: AWS profile name.
     required: true
   aws-region:
     description: AWS Region, e.g. us-east-2

diff --git a/dist/cleanup/index.js b/dist/cleanup/index.js
@@ -1,85 +1,6 @@
 /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
-/***/ 9671:
-/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-
-"use strict";
-
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.cleanup = void 0;
-const fs_1 = __importDefault(__nccwpck_require__(7147));
-const os_1 = __importDefault(__nccwpck_require__(2037));
-const path_1 = __importDefault(__nccwpck_require__(1017));
-const core = __importStar(__nccwpck_require__(2186));
-const utils_1 = __nccwpck_require__(4140);
-function cleanup() {
-    const profile = core.getInput("profile");
-    const awsDir = path_1.default.join(os_1.default.homedir(), ".aws");
-    const credentialsPath = path_1.default.join(awsDir, "credentials");
-    if (fs_1.default.existsSync(credentialsPath)) {
-        const credentials = fs_1.default.readFileSync(credentialsPath, "utf-8");
-        if (!credentials.includes(`[${profile}]`))
-            return;
-        const sections = credentials.split(/\r?\n\s*\r?\n/);
-        const filteredSections = sections.filter(section => !section.startsWith(`[${profile}]`));
-        fs_1.default.writeFileSync(credentialsPath, filteredSections.join("\n\n"));
-    }
-}
-exports.cleanup = cleanup;
-if (require.main === require.cache[eval('__filename')]) {
-    try {
-        cleanup();
-    }
-    catch (error) {
-        core.setFailed((0, utils_1.errorMessage)(error));
-    }
-}
-
-
-/***/ }),
-
-/***/ 4140:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.errorMessage = void 0;
-function errorMessage(error) {
-    return error instanceof Error ? error.message : String(error);
-}
-exports.errorMessage = errorMessage;
-
-
-/***/ }),
-
 /***/ 7351:
 /***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
 
@@ -24325,6 +24246,85 @@ function version(uuid) {
 var _default = version;
 exports["default"] = _default;
 
+/***/ }),
+
+/***/ 3812:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.cleanup = void 0;
+const fs_1 = __importDefault(__nccwpck_require__(7147));
+const os_1 = __importDefault(__nccwpck_require__(2037));
+const path_1 = __importDefault(__nccwpck_require__(1017));
+const core = __importStar(__nccwpck_require__(2186));
+const utils_1 = __nccwpck_require__(1314);
+function cleanup() {
+    const profile = core.getInput("profile");
+    const awsDir = path_1.default.join(os_1.default.homedir(), ".aws");
+    const credentialsPath = path_1.default.join(awsDir, "credentials");
+    if (fs_1.default.existsSync(credentialsPath)) {
+        const credentials = fs_1.default.readFileSync(credentialsPath, "utf-8");
+        if (!credentials.includes(`[${profile}]`))
+            return;
+        const sections = credentials.split(/\r?\n\s*\r?\n/);
+        const filteredSections = sections.filter(section => !section.startsWith(`[${profile}]`));
+        fs_1.default.writeFileSync(credentialsPath, filteredSections.join("\n\n"));
+    }
+}
+exports.cleanup = cleanup;
+if (require.main === require.cache[eval('__filename')]) {
+    try {
+        cleanup();
+    }
+    catch (error) {
+        core.setFailed((0, utils_1.errorMessage)(error));
+    }
+}
+
+
+/***/ }),
+
+/***/ 1314:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.errorMessage = void 0;
+function errorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+exports.errorMessage = errorMessage;
+
+
 /***/ }),
 
 /***/ 9491:
@@ -26212,7 +26212,7 @@ module.exports = parseParams
 /******/ 	// startup
 /******/ 	// Load entry module and return exports
 /******/ 	// This entry module is referenced by other modules so it can't be inlined
-/******/ 	var __webpack_exports__ = __nccwpck_require__(9671);
+/******/ 	var __webpack_exports__ = __nccwpck_require__(3812);
 /******/ 	module.exports = __webpack_exports__;
 /******/ 	
 /******/ })()