├── test ├── result │ ├── bash.json │ ├── bash_string │ ├── node.json │ ├── node_string │ ├── php.json │ ├── python_string │ ├── elixir_string │ ├── golang.json │ ├── golang_string │ ├── python.json │ ├── haskell.json │ ├── python_second.json │ ├── test_before_script │ ├── perl.json │ ├── ruby.json │ └── ruby_second.json └── func_examples │ ├── requirements.txt │ ├── function.exs │ ├── test_before_script.py.sh │ ├── function.php │ ├── function.pl │ ├── function.hs │ ├── test_before_script.py │ ├── function.js │ ├── function.sh │ ├── function.rb │ ├── function.go │ └── function.py ├── action.yml ├── .github └── workflows │ └── test_run_funcs.yml ├── .gitignore ├── README.md └── LICENSE /test/result/bash.json: -------------------------------------------------------------------------------- 1 | {"hello": "bash"} -------------------------------------------------------------------------------- /test/result/bash_string: -------------------------------------------------------------------------------- 1 | hello, world -------------------------------------------------------------------------------- /test/result/node.json: -------------------------------------------------------------------------------- 1 | {"hello":"world"} -------------------------------------------------------------------------------- /test/result/node_string: -------------------------------------------------------------------------------- 1 | hello, node -------------------------------------------------------------------------------- /test/result/php.json: -------------------------------------------------------------------------------- 1 | {"hello":"world"} -------------------------------------------------------------------------------- /test/result/python_string: -------------------------------------------------------------------------------- 1 | hello world -------------------------------------------------------------------------------- /test/result/elixir_string: -------------------------------------------------------------------------------- 1 | hello, elixir 2 | -------------------------------------------------------------------------------- /test/result/golang.json: -------------------------------------------------------------------------------- 1 | {"hello":"golang"} -------------------------------------------------------------------------------- /test/result/golang_string: -------------------------------------------------------------------------------- 1 | Hello, Golang! -------------------------------------------------------------------------------- /test/result/python.json: -------------------------------------------------------------------------------- 1 | {"hello": "world"} -------------------------------------------------------------------------------- /test/result/haskell.json: -------------------------------------------------------------------------------- 1 | {"Hello": "World!"} 2 | -------------------------------------------------------------------------------- /test/result/python_second.json: -------------------------------------------------------------------------------- 1 | {"hello": "world"} -------------------------------------------------------------------------------- /test/result/test_before_script: -------------------------------------------------------------------------------- 1 | hello, prehook 2 | -------------------------------------------------------------------------------- /test/func_examples/requirements.txt: -------------------------------------------------------------------------------- 1 | openpyxl==3.0.5 2 | -------------------------------------------------------------------------------- /test/result/perl.json: -------------------------------------------------------------------------------- 1 | {"language": "Perl", "hello": "world"} 2 | -------------------------------------------------------------------------------- /test/result/ruby.json: -------------------------------------------------------------------------------- 1 | {"en":"English","others":{"fr":"Franch","sp":"Spanish"}} -------------------------------------------------------------------------------- /test/result/ruby_second.json: -------------------------------------------------------------------------------- 1 | {"en":"English","others":{"fr":"Franch","sp":"Spanish"}} -------------------------------------------------------------------------------- /test/func_examples/function.exs: -------------------------------------------------------------------------------- 1 | # GET /test/result/elixir_string 2 | 3 | IO.puts("hello, elixir") 4 | -------------------------------------------------------------------------------- /test/func_examples/test_before_script.py.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | echo "hello, prehook" > /tmp/test_before_script.txt 4 | -------------------------------------------------------------------------------- /test/func_examples/function.php: -------------------------------------------------------------------------------- 1 | 'world']); 6 | -------------------------------------------------------------------------------- /test/func_examples/function.pl: -------------------------------------------------------------------------------- 1 | use v5.10; 2 | 3 | # GET /test/result/perl.json 4 | 5 | say '{"language": "Perl", "hello": "world"}' 6 | -------------------------------------------------------------------------------- /test/func_examples/function.hs: -------------------------------------------------------------------------------- 1 | 2 | -- GET /test/result/haskell.json 3 | 4 | main :: IO () 5 | main = putStrLn "{\"Hello\": \"World!\"}" 6 | -------------------------------------------------------------------------------- /test/func_examples/test_before_script.py: -------------------------------------------------------------------------------- 1 | 2 | with open('/tmp/test_before_script.txt', 'r') as fh: 3 | # GET /test/result/test_before_script 4 | print(fh.read().splitlines()[0]) 5 | -------------------------------------------------------------------------------- /test/func_examples/function.js: -------------------------------------------------------------------------------- 1 | // GET /test/result/node.json 2 | 3 | console.log(JSON.stringify({hello: "world"})) 4 | 5 | // GET /test/result/node_string 6 | 7 | console.log("hello, node") 8 | -------------------------------------------------------------------------------- /test/func_examples/function.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # GET /test/result/bash_string 4 | 5 | echo "hello, world" 6 | 7 | # GET /test/result/bash.json 8 | 9 | echo '{"hello": "bash"}' 10 | -------------------------------------------------------------------------------- /test/func_examples/function.rb: -------------------------------------------------------------------------------- 1 | require 'json' 2 | 3 | # GET /test/result/ruby.json 4 | languages = { en: "English", others: { fr: "Franch", sp: "Spanish"} } 5 | puts JSON.dump languages 6 | 7 | # GET /test/result/ruby_second.json 8 | puts JSON.dump languages 9 | 10 | # PUT /test/result/ruby_third.json 11 | puts JSON.dump languages 12 | -------------------------------------------------------------------------------- /test/func_examples/function.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | ) 7 | 8 | func main() { 9 | // GET /test/result/golang_string 10 | fmt.Println("Hello, Golang!") 11 | 12 | // GET /test/result/golang.json 13 | greet := map[string]string{"hello": "golang"} 14 | j, _ := json.Marshal(greet) 15 | fmt.Println(string(j)) 16 | } 17 | -------------------------------------------------------------------------------- /test/func_examples/function.py: -------------------------------------------------------------------------------- 1 | import json 2 | # import but not used, just for testing package installation 3 | import openpyxl 4 | 5 | # GET /test/result/python.json 6 | 7 | greeting = {"hello": "world"} 8 | print(json.dumps(greeting)) 9 | 10 | # GET /test/result/python_second.json 11 | 12 | print(json.dumps(greeting)) 13 | 14 | # GET /test/result/python_string 15 | 16 | print("hello world") 17 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'ActionServerless' 2 | description: Use GitHub Actions to create a serverless service 3 | inputs: 4 | filepath: # id of input 5 | description: 'A file path where to read source code' 6 | required: false 7 | write_mode: 8 | description: 'Output write mode(overwrite/append)' 9 | required: false 10 | default: 'overwrite' 11 | runs: 12 | using: "composite" 13 | steps: 14 | - id: run-funcs 15 | run: | 16 | export GITFX_WRITE_MODE=${{ inputs.write_mode }} 17 | python3 -m pip install gitfx 18 | python3 -m gitfx ${{ inputs.filepath }} 19 | shell: bash 20 | - name: Git commit 21 | run: | 22 | # git commit if there's any change 23 | if test -n "$(git status --porcelain 2>/dev/null)"; then 24 | git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" 25 | git config --local user.name "github-actions[bot]" 26 | git add . 27 | git commit -m "Add changes" 28 | git push origin ${GITHUB_REF##*/} 29 | fi 30 | shell: bash 31 | branding: 32 | icon: 'cloud-lightning' 33 | color: 'purple' 34 | -------------------------------------------------------------------------------- /.github/workflows/test_run_funcs.yml: -------------------------------------------------------------------------------- 1 | name: Test run funcs 2 | 3 | on: [push] 4 | 5 | permissions: 6 | contents: write 7 | 8 | jobs: 9 | test_ruby_func: 10 | runs-on: ubuntu-latest 11 | name: A job to test run functions 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v2 15 | - name: Clear result files ahead for test 16 | run: rm -rf test/result 17 | - name: Run funcs 18 | uses: ./ 19 | with: 20 | filepath: test/func_examples 21 | - name: Check if result files exist 22 | run: | 23 | cd test/result 24 | 25 | files=(elixir_string 26 | 27 | golang.json 28 | golang_string 29 | 30 | haskell.json 31 | 32 | node.json 33 | node_string 34 | 35 | perl.json 36 | 37 | php.json 38 | 39 | python.json 40 | python_second.json 41 | python_string 42 | 43 | ruby.json 44 | ruby_second.json 45 | 46 | test_before_script 47 | 48 | bash_string 49 | bash.json 50 | ) 51 | 52 | status=0 53 | 54 | for f in "${files[@]}" 55 | do 56 | if [ ! -f $f ]; then 57 | echo "File not found: $f" 58 | status=1 59 | fi 60 | done 61 | 62 | exit $status 63 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ActionServerless - Use GitHub Actions to create a serverless service 2 | 3 | [![ActionServerless Testing](https://github.com/gitfx/ActionServerless/workflows/Test%20run%20funcs/badge.svg)](https://github.com/gitfx/ActionServerless/blob/master/.github/workflows/test_run_funcs.yml) 4 | 5 | ActionServerless is an action using [GitFx](https://github.com/gitfx/GitFx) to do some computing and then generate a string/JSON file to a path, you can visit the file as a service when in dev/testing, or even in your production. We may take it as a GitHub Actions powered `serverless` service. 6 | 7 | In fact you can do all of these in native GitHub actions. ActionServerless just wraps the steps to simplify the work: 8 | 9 | 1. you can focus on coding the real logic, no need to care too much setup steps on the languages that ActionServerless supported(JS/Ruby/Python/Perl etc.). With [a template](https://github.com/gitfx/ActionServerless-template) we provide, you even don't bother to edit the action workflow configuration. 10 | 2. use the route grammer we defined to specify a path to store the generated string/JSON file, that makes the job easy and clear. 11 | 12 | ## Quick start 13 | 14 | At first [use the template](https://github.com/gitfx/ActionServerless-template/generate) to create a repository. Then We start with a Python example: 15 | 16 | ```python 17 | # function.py 18 | import json 19 | 20 | # GET /api/py_hello.json 21 | 22 | print(json.dumps({"hello": "world"})) 23 | ``` 24 | 25 | put the file to a path(default is the root path of a repo, otherwise you need add the path as an argument to your actions configuaration), when you push the code the action will be triggered. Then the program's output is written to a file located in `api/py_hello.json` that you defined as a route in the comment. 26 | 27 | more languages' examples you can find [here](https://github.com/gitfx/GitFx/tree/master/test/func_examples). 28 | 29 | ## Languages supported 30 | 31 | See: https://github.com/gitfx/GitFx#languages-supported 32 | 33 | 34 | ## Documents 35 | 36 | See: https://github.com/gitfx/GitFx#documents 37 | 38 | ## Real world examples 39 | 40 | See: https://github.com/gitfx/GitFx#real-world-examples 41 | 42 | ## Contributions 43 | 44 | Contributions are welcome! You may check the following features in case you'd like to contribute but no idea what to do: 45 | 46 | * Support to add your favorite languages 47 | * Support dependency installation to the existing languages 48 | * Use this action to create an application and share it 49 | 50 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------