add cleanup process (#224)

* add cleanup process

* save state

* update README/CHANGELOG

* fix message

* `getSshDirectory()` should not be exported

.eslintrc.yml

@@ -161,7 +161,7 @@ rules: # https://eslint.org/docs/rules/
   - error
   - max: 1
   no-native-reassign: error
-  no-negated-condition: error
+  no-negated-condition: 'off'
   no-negated-in-lhs: error
   no-nested-ternary: error
   no-new: error

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+* reomve SSH directory at the end of workflow
+
 ## [2.4.0] - 2022-11-03
 
 ### Added

README.md

@@ -45,7 +45,10 @@ steps:
 
 See [Workflow syntax for GitHub Actions](https://help.github.com/en/articles/workflow-syntax-for-github-actions) for details.
 
-**NOTE:** Server key of `github.com` will be always set to `known_hosts`.
+**NOTE:**
+
+* Server key of `github.com` will be always set to `known_hosts`.
+* SSH keys will be removed at the end of workflow.
 
 ### Install multiple keys
 

action.yml

@@ -28,3 +28,4 @@ inputs:
 runs:
   using: "node16"
   main: "lib/index.js"
+  post: "lib/index.js"

lib/index.js

@@ -2738,6 +2738,31 @@ catch (err) {
  * main function
  */
 function main() {
+    if (!isPost()) {
+        setup();
+        setPost();
+    }
+    else {
+        cleanup();
+    }
+}
+/**
+ * is post process?
+ * @returns Yes/No
+ */
+function isPost() {
+    return Boolean(core.getState("isPost"));
+}
+/**
+ * update post state
+ */
+function setPost() {
+    core.saveState("isPost", "true");
+}
+/**
+ * setup function
+ */
+function setup() {
     // parameters
     const key = core.getInput("key", {
         required: true,
@@ -2788,19 +2813,45 @@ function main() {
     }
     console.log(`SSH key has been stored to ${sshDirName} successfully.`);
 }
+/**
+ * cleanup function
+ */
+function cleanup() {
+    // remove ".ssh" directory
+    const sshDirName = removeSshDirectory();
+    console.log(`SSH key in ${sshDirName} has been removed successfully.`);
+}
 /**
  * create ".ssh" directory
  * @returns directory name
  */
 function createSshDirectory() {
-    const home = getHomeDirectory();
+    const dirName = getSshDirectory();
-    const dirName = path_1.default.resolve(home, ".ssh");
     fs_1.default.mkdirSync(dirName, {
         recursive: true,
         mode: 0o700,
     });
     return dirName;
 }
+/**
+ * remove ".ssh" directory
+ * @returns removed directory name
+ */
+function removeSshDirectory() {
+    const dirName = getSshDirectory();
+    fs_1.default.rmSync(dirName, {
+        recursive: true,
+        force: true,
+    });
+    return dirName;
+}
+/**
+ * get SSH directory
+ * @returns SSH directory name
+ */
+function getSshDirectory() {
+    return path_1.default.resolve(getHomeDirectory(), ".ssh");
+}
 /**
  * get home directory
  * @returns home directory name

src/main.ts

@@ -25,6 +25,33 @@ try {
  * main function
  */
 function main(): void {
+    if (!isPost()) {
+        setup();
+        setPost();
+    } else {
+        cleanup();
+    }
+}
+
+/**
+ * is post process?
+ * @returns Yes/No
+ */
+function isPost(): boolean {
+    return Boolean(core.getState("isPost"));
+}
+
+/**
+ * update post state
+ */
+function setPost(): void {
+    core.saveState("isPost", "true");
+}
+
+/**
+ * setup function
+ */
+function setup(): void {
     // parameters
     const key = core.getInput("key", {
         required: true,
@@ -80,13 +107,22 @@ function main(): void {
     console.log(`SSH key has been stored to ${sshDirName} successfully.`);
 }
 
+/**
+ * cleanup function
+ */
+function cleanup(): void {
+    // remove ".ssh" directory
+    const sshDirName = removeSshDirectory();
+
+    console.log(`SSH key in ${sshDirName} has been removed successfully.`);
+}
+
 /**
  * create ".ssh" directory
  * @returns directory name
  */
 function createSshDirectory(): string {
-    const home = getHomeDirectory();
+    const dirName = getSshDirectory();
-    const dirName = path.resolve(home, ".ssh");
     fs.mkdirSync(dirName, {
         recursive: true,
         mode: 0o700,
@@ -94,6 +130,27 @@ function createSshDirectory(): string {
     return dirName;
 }
 
+/**
+ * remove ".ssh" directory
+ * @returns removed directory name
+ */
+function removeSshDirectory(): string {
+    const dirName = getSshDirectory();
+    fs.rmSync(dirName, {
+        recursive: true,
+        force: true,
+    });
+    return dirName;
+}
+
+/**
+ * get SSH directory
+ * @returns SSH directory name
+ */
+function getSshDirectory(): string {
+    return path.resolve(getHomeDirectory(), ".ssh");
+}
+
 /**
  * get home directory
  * @returns home directory name