Source Code For V2.0

CHANGELOG.md

@@ -0,0 +1,7 @@
+# 2.0 - 28/04/2020
+* Major Rework Done
+* Reduced Run Time Usage
+* Added Option to use this action just as a document generator
+
+# 1.0 - 26/07/2019
+* First Version Released.

Dockerfile

@@ -1,4 +1,3 @@
-#FROM alpine:latest
 FROM php:7.1-cli-alpine3.10
 
 RUN apk add git

README.md

@@ -1,39 +1,42 @@
-> **⚠️ Note:** To use this GitHub Action, you must have access to GitHub Actions. GitHub Actions are currently only available in public beta. You can [apply for Github Actions beta access here](https://github.com/features/actions).
-
 # ApiGen - ***Github Action***
-Github Action To Generate Code Docs Website For PHP Using ApiGen
+Simple Github Action Which Helps You To Generate PHP Code Documentation Website Using ApiGen
 
 ## Configuration
 | Argument | Default | Description |
 | --- | ------- | ----------- |
 |`push_to_branch` | gh-pages | Which Branch To Push |
 |`before_cmd` | null | Option to run custom cmd before generating docs |
 |`after_cmd` | null | Option to run custom cmd after generating docs |
+|`auto_push` | Yes | If set the `Yes` then it auto pushes generated files to current github repo to the branch defined in `push_to_branch` |
+|`output_folder` | null | This option can be used to provide custom output folder if `auto_push` is disabled |
+|`source_folder` | null | This option can be used to provide custom source folder if `auto_push` is disabled |
 ---
 
 > **Note** Provide A Branch Which is only for the docs. if any other contents in it then all will be deleted **DO NOT USE : MASTER**  
 
 
 ## Example Workflow File
 ```yaml
-name: ApiGen
+name: ON_PUSH
 
-on: [push]
+on:
+  push:
+    branches:
+      - master
 
 jobs:
-  apigen:
+  Document_Generator:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - name: ApiGen Docs Generator
-      uses: varunsridharan/action-apigen@master
+    - name: 📝 ApiGen PHP Document Generator
+      uses: varunsridharan/action-apigen@2.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
 ```
 
 ---
-
 ## Contribute
 If you would like to help, please take a look at the list of
 [issues][issues] or the [To Do](#-todo) checklist.

action.yml

@@ -1,5 +1,5 @@
 name: 'ApiGen Docs'
-description: 'Github Action To Generate Code Docs Website For PHP Using ApiGen'
+description: 'Simple Github Action Which Helps You To Generate PHP Code Documentation Website Using ApiGen'
 author: 'varunsridharan'
 branding:
   icon: 'hard-drive'
@@ -9,19 +9,19 @@ inputs:
     description: 'Which Branch/Folder To Push'
     default: 'gh-pages'
   before_cmd:
-    description: 'Custom Command To Run Before Generating Docs'
+    description: 'Command To Run Before ApiGen'
     default: ''
   after_cmd:
-    description: 'Custom Command To Run After Generating Docs'
+    description: 'Command To Run After ApiGen'
     default: ''
   auto_push:
-    description: 'IF this can auto push to the repo'
+    description: 'if set to yes then it auto pushes latest source to current repo with the push_to_branch'
     default: 'yes'
   output_folder:
-    description: 'Custom Output Folder if auto_push is disabled'
+    description: 'Custom output folder if auto_push is disabled'
     default: ''
   source_folder:
-    description: 'Custom Source Folder'
+    description: 'Custom Source Folder if auto_push is disabled'
     default: ''
 
 runs: