feat: add the directory workflow as a GitHub Action (#8)

Panquesito7 · tjgurwara99 · web-flow · commit 6a466a22d2c3 · 2023-01-16T13:11:19.000-06:00
* feat: convert the directory workflow to...

...GitHub Actions. The script is still kept, but GitHub Actions is preferred instead.

* chore: apply suggestions from code review

Co-authored-by: Taj &lt;tjgurwara99@users.noreply.github.com&gt;
diff --git a/.github/workflows/directory-ignore-files.yml b/.github/workflows/directory-ignore-files.yml
@@ -0,0 +1,17 @@
+name: DIRECTORY.md workflow (ignore directories)
+on:
+  push:
+    branches:
+      - 'main'
+jobs:
+  directory_builder:
+    runs-on: ubuntu-latest
+    name: Verify the DIRECTORY.md workflow works
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./directory_md
+        with:
+          language: C++
+          working-directory: .
+          filetypes: .cpp,.hpp
+          ignored-directories: ./test
diff --git a/.github/workflows/directory.yml b/.github/workflows/directory.yml
@@ -0,0 +1,16 @@
+name: DIRECTORY.md workflow
+on:
+  push:
+    branches:
+      - 'main'
+jobs:
+  directory_builder:
+    runs-on: ubuntu-latest
+    name: Verify the DIRECTORY.md workflow works
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./directory_md
+        with:
+          language: C++
+          working-directory: ./test
+          filetypes: .cpp,.hpp
diff --git a/.github/workflows/formatter-ignore-files.yml b/.github/workflows/formatter-ignore-files.yml
diff --git a/.github/workflows/formatter.yml b/.github/workflows/formatter.yml
@@ -1,5 +1,8 @@
 name: Test without ignore directory argument
-on: workflow_dispatch
+on:
+  push:
+    branches:
+      - 'main'
 jobs:
   formatter:
     runs-on: ubuntu-latest
diff --git a/directory_md/action.yml b/directory_md/action.yml
@@ -0,0 +1,33 @@
+name: "Build directory file"
+description: "Builds a DIRECTORY.md file with all the algorithms in one repository."
+author: "TheAlgorithms"
+inputs:
+  language:
+    description: The language used in your repository
+    required: true
+  working-directory:
+    description: Working/base directory of the script
+    required: true
+    default: .
+  filetypes:
+    description: Allowed filenames to check in (comma separated values in a string). Can have unlimited filetypes. E.g. `.cpp,.hpp,.h`
+    required: true
+  ignored-directories:
+    description: Files or folders to ignore, separated by commas.
+    required: false
+  ignore-folders-children:
+    description: Folders to ignore, but include children.
+    required: false
+runs:
+  using: composite
+  steps:
+    - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
+      shell: bash
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.10 # or whatever version you support
+    - name: Running the formatter
+      shell: bash
+      run: |
+        python ./build_directory_md.py ${{ inputs.language }} ${{ inputs.working-directory }} ${{ inputs.filetypes }} ${{ inputs.ignored-directories }} ${{ inputs.ignore-folders-children }} > DIRECTORY.md
diff --git a/filename_formatter.sh b/filename_formatter.sh
@@ -51,4 +51,4 @@ do
         git "mv" "${fname}" "${new_fname}" # Requires you to be in version control
     fi
 done
-unset IFS; set +f
+unset IFS; set +f
diff --git a/formatter/filename_formatter.sh b/formatter/filename_formatter.sh
