Deploy

Author: owjs3901

README.md

@@ -1 +1,72 @@
-# github-action-template
+### Collect Env
+
+This GitHub Action allows you to collect environment variables with a specific prefix and write them to a file. It is useful when you want to extract environment variables that match a certain pattern and save them to a `.env` file for deployment or configuration purposes.
+
+#### Usage
+
+```yaml
+- name: Collect environment variables
+  uses: ./action-tools/collect-env
+  with:
+    prefix: 'API_'
+    output: '.env.api'
+    remove-prefix: true
+```
+
+#### Inputs
+
+| Name | Description | Required | Default |
+|------|-------------|----------|---------|
+| prefix | The prefix to filter environment variables by | true | - |
+| output | The output file to write the collected variables to | true | - |
+| remove-prefix | Whether to remove the prefix from variable names in the output | false | false |
+
+#### Example Workflow
+
+```yaml
+name: Collect API environment variables
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  collect-env:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Collect API environment variables
+        uses: dev-five-git/collect-env-action@main
+        with:
+          prefix: 'API_'
+          output: '.env.api'
+          remove-prefix: true
+```
+
+#### Example
+
+If you have the following environment variables:
+- `API_KEY=secret123`
+- `API_URL=https://api.example.com`
+- `API_TIMEOUT=5000`
+- `DATABASE_URL=postgres://localhost`
+
+And you run the action with:
+- `prefix: 'API_'`
+- `remove-prefix: true`
+
+The output file will contain:
+```
+KEY=secret123
+URL=https://api.example.com
+TIMEOUT=5000
+```
+
+If `remove-prefix: false`, the output will be:
+```
+API_KEY=secret123
+API_URL=https://api.example.com
+API_TIMEOUT=5000
+```

action.yml

@@ -1,20 +1,23 @@
-name: Github Action Template
-description: Github Action Template
+name: Collect Env
+description: Collect env values and write to a file
 author: JeongMin Oh
 
 branding:
-  icon: file-text
+  icon: key
   color: purple
 
 inputs:
-  input:
-    description: The file to read from
-    required: true
-    default: .env.development
+  prefix:
+    description: The prefix to collect
+    required: false
   output:
-    description: The file to overwrite to
+    description: The file to write to
     required: true
-    default: .env.production
+  remove-prefix:
+    description: The prefix to remove
+    required: false
+    type: boolean
+    default: true
 
 runs:
   using: node24

bun.lock

@@ -1,7 +1,7 @@
 {
-	"name": "action-tools",
+	"name": "collect-env",
 	"version": "1.0.0",
-	"description": "github action template",
+	"description": "Collect env values and write to a file",
 	"author": "JeongMin Oh",
 	"license": "Apache-2.0",
 	"scripts": {
@@ -10,6 +10,10 @@
 		"lint:fix": "biome check --write",
 		"prepare": "husky"
 	},
+	"dependencies": {
+		"@actions/core": "^1.11",
+		"@actions/io": "^1.1"
+	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.2",
 		"@types/bun": "^1.3",

dist/index.js

@@ -0,0 +1,159 @@
+import { expect, mock, test } from 'bun:test'
+import { writeFile } from 'node:fs/promises'
+import { getBooleanInput, getInput, setFailed } from '@actions/core'
+
+const mockWriteFile = mock(writeFile)
+const mockGetInput = mock(getInput)
+const mockSetFailed = mock(setFailed)
+const mockGetBooleanInput = mock(getBooleanInput)
+
+mock.module('node:fs/promises', () => ({
+  writeFile: mockWriteFile,
+}))
+
+mock.module('@actions/core', () => ({
+  getInput: mockGetInput,
+  setFailed: mockSetFailed,
+  getBooleanInput: mockGetBooleanInput,
+}))
+
+import { run } from '../run'
+
+test('should write filtered environment variables to file', async () => {
+  const testPrefix = 'TEST_'
+  const testOutput = 'test.env'
+
+  process.env.TEST_VAR1 = 'value1'
+  process.env.TEST_VAR2 = 'value2'
+  process.env.OTHER_VAR = 'other'
+
+  mockGetInput.mockImplementation((name: string) => {
+    switch (name as 'prefix' | 'output') {
+      case 'prefix':
+        return testPrefix
+      case 'output':
+        return testOutput
+    }
+  })
+
+  mockWriteFile.mockResolvedValue(undefined)
+  mockGetBooleanInput.mockReturnValue(false)
+
+  await run()
+
+  expect(mockGetInput).toHaveBeenCalledWith('prefix')
+  expect(mockGetInput).toHaveBeenCalledWith('output')
+  expect(mockGetBooleanInput).toHaveBeenCalledWith('remove-prefix')
+  expect(mockWriteFile).toHaveBeenCalledWith(
+    testOutput,
+    'TEST_VAR1=value1\nTEST_VAR2=value2',
+  )
+})
+
+test('should handle writeFile error', async () => {
+  const testPrefix = 'TEST_'
+  const testOutput = 'test.env'
+  const testError = 'Write failed'
+
+  process.env.TEST_VAR = 'value'
+
+  mockGetInput.mockImplementation((name: string) => {
+    switch (name as 'prefix' | 'output') {
+      case 'prefix':
+        return testPrefix
+      case 'output':
+        return testOutput
+    }
+  })
+
+  mockWriteFile.mockRejectedValue(testError)
+  mockGetBooleanInput.mockReturnValue(false)
+
+  await run()
+
+  expect(mockSetFailed).toHaveBeenCalledWith(testError)
+  process.exitCode = 0
+})
+
+test('should handle empty environment variables', async () => {
+  const testPrefix = 'NONEXISTENT_'
+  const testOutput = 'empty.env'
+
+  mockGetInput.mockImplementation((name: string) => {
+    switch (name as 'prefix' | 'output') {
+      case 'prefix':
+        return testPrefix
+      case 'output':
+        return testOutput
+    }
+  })
+
+  mockWriteFile.mockResolvedValue(undefined)
+  mockGetBooleanInput.mockReturnValue(false)
+
+  await run()
+
+  expect(mockWriteFile).toHaveBeenCalledWith(testOutput, '')
+})
+
+test('should filter environment variables by prefix', async () => {
+  const testPrefix = 'API_'
+  const testOutput = 'api.env'
+
+  process.env.API_KEY = 'secret123'
+  process.env.API_URL = 'https://api.example.com'
+  process.env.DATABASE_URL = 'postgres://localhost'
+  process.env.API_TIMEOUT = '5000'
+
+  mockGetInput.mockImplementation((name: string) => {
+    switch (name as 'prefix' | 'output') {
+      case 'prefix':
+        return testPrefix
+      case 'output':
+        return testOutput
+    }
+  })
+
+  mockWriteFile.mockResolvedValue(undefined)
+  mockGetBooleanInput.mockReturnValue(false)
+  await run()
+
+  const expectedContent = [
+    'API_KEY=secret123',
+    'API_URL=https://api.example.com',
+    'API_TIMEOUT=5000',
+  ].join('\n')
+
+  expect(mockWriteFile).toHaveBeenCalledWith(testOutput, expectedContent)
+})
+
+test('should remove prefix from environment variables', async () => {
+  const testPrefix = 'API_'
+  const testOutput = 'api.env'
+  const testRemovePrefix = true
+  process.env.API_KEY = 'secret123'
+  process.env.API_URL = 'https://api.example.com'
+  process.env.API_TIMEOUT = '5000'
+
+  mockGetInput.mockImplementation((name: string) => {
+    switch (name as 'prefix' | 'output') {
+      case 'prefix':
+        return testPrefix
+      case 'output':
+        return testOutput
+    }
+  })
+
+  mockWriteFile.mockResolvedValue(undefined)
+  mockGetBooleanInput.mockReturnValue(testRemovePrefix)
+
+  await run()
+
+  const expectedContent = [
+    'KEY=secret123',
+    'URL=https://api.example.com',
+    'TIMEOUT=5000',
+  ].join('\n')
+
+  expect(mockWriteFile).toHaveBeenCalledWith(testOutput, expectedContent)
+})

package.json

@@ -1 +1,23 @@
-export async function run() {}
+import { writeFile } from 'node:fs/promises'
+import { getBooleanInput, getInput, setFailed } from '@actions/core'
+
+export async function run() {
+  const prefix = getInput('prefix')
+  const output = getInput('output')
+  const removePrefix = getBooleanInput('remove-prefix')
+
+  try {
+    await writeFile(
+      output,
+      Object.entries(process.env)
+        .filter(([key]) => key.startsWith(prefix))
+        .map(
+          ([key, value]) =>
+            `${removePrefix ? key.substring(prefix.length) : key}=${value}`,
+        )
+        .join('\n'),
+    )
+  } catch (err: unknown) {
+    setFailed(err as Error)
+  }
+}