Update

Author: owjs3901

README.md

@@ -1,6 +1,30 @@
 # Action Tools
 
 ## Actions
+
+### 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 |
+
 ### Overwrite Env File
 
 This GitHub Action allows you to overwrite the contents of an environment file with the contents of another file. It is useful when you want to promote/stage environment variables from one environment to another (for example, from a `.env.development` file to a `.env.production` file) automatically in your workflows.
@@ -11,16 +35,16 @@ This GitHub Action allows you to overwrite the contents of an environment file w
 - name: Overwrite production env file with development env file
   uses: ./action-tools/overwrite-env-file
   with:
-    input-file: .env.development
-    output-file: .env.production
+    input: .env.development
+    output: .env.production
 ```
 
 #### Inputs
 
 | Name         | Description                  | Required | Default             |
 |--------------|------------------------------|----------|---------------------|
-| input-file   | The file to read from        | true     | .env.development    |
-| output-file  | The file to overwrite to     | true     | .env.production     |
+| input   | The file to read from        | true     | .env.development    |
+| output  | The file to overwrite to     | true     | .env.production     |
 
 #### Example Workflow
 
@@ -41,7 +65,7 @@ jobs:
       - name: Overwrite production env file with development env file
         uses: ./actions/overwrite-env-file
         with:
-          input-file: .env.development
-          output-file: .env.production
+          input: .env.development
+          output: .env.production
 ```
 

actions/collect-env/README.md

@@ -0,0 +1,72 @@
+### 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: ./actions/collect-env
+        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
+```

actions/overwrite-env-file/README.md

@@ -0,0 +1,43 @@
+### Overwrite Env File
+
+This GitHub Action allows you to overwrite the contents of an environment file with the contents of another file. It is useful when you want to promote/stage environment variables from one environment to another (for example, from a `.env.development` file to a `.env.production` file) automatically in your workflows.
+
+#### Usage
+
+```yaml
+- name: Overwrite production env file with development env file
+  uses: ./action-tools/overwrite-env-file
+  with:
+    input: .env.development
+    output: .env.production
+```
+
+#### Inputs
+
+| Name         | Description                  | Required | Default             |
+|--------------|------------------------------|----------|---------------------|
+| input   | The file to read from        | true     | .env.development    |
+| output  | The file to overwrite to     | true     | .env.production     |
+
+#### Example Workflow
+
+```yaml
+name: Promote env to production
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  promote-env:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Overwrite production env file with development env file
+        uses: ./actions/overwrite-env-file
+        with:
+          input: .env.development
+          output: .env.production
+```