ActionServerless - Use GitHub Actions to create a serverless service
ActionServerless is an action 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.
In fact you can do all of these in native GitHub actions. ActionServerless just wraps the steps to simplify the work:
- 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 we provide, you even don't bother to edit the action workflow configuration.
- use the route grammer we defined to specify a path to store the generated string/JSON file, that makes the job easy and clear.
Quick start
At first use the template to create a repository. Then We start with a Python example:
# function.py
import json
# GET /api/py_hello.json
print(json.dumps({"hello": "world"}))
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.
more languages' examples you can find here.
Languages supported
| Language | Dependency Installation |
|---|---|
| Python |
requirements.txt |
| Ruby |
Gemfile |
| Node.js |
package.json |
| Perl |
cpanfile |
| Golang |
|
| Haskell |
|
| Elixir |
|
| PHP |
|
HTTP Headers
If we'd like to be serious to take visiting such a GitHub raw file as a 'service', it's no problem for most situations as you request a normal HTTP service. But GitHub returns a text/html for any raw files it serves, that might lead to some bugs though I can't give an example yet.
So we provide a header rewrite service, which returns an application/json header for the json format files(those generated file suffixed with .json), and a text/plain header for the rest(those string or any text-based format files).
Header rewrite usage
Fox example, here's a raw url of the file:
https://raw.githubusercontent.com/gitx-io/ActionServerless/master/README.md
its corresponding header-rewritten url should be:
https://gitx.io/j/gitx-io/ActionServerless/master/README.md
just use gitx.io/j/ to replace the raw.githubusercontent.com/ segment.
Contributions
Contributions are welcome! You may check the following features in case you'd like to contribute but no idea what to do:
- Support to add your favorite languages
- Support dependency installation to the existing languages
- Use this action to create an application and share it
2 Jul 20, 2022
1 Nov 21, 2021
6 May 16, 2022
1 Jan 21, 2022
1 Feb 9, 2022
45.3k Jan 2, 2023
4 Aug 8, 2021
11 Dec 17, 2022
17 Dec 5, 2022
325 Dec 01, 2022
19 Jan 06, 2023
3 Jan 06, 2022
29 Dec 21, 2022
1 Nov 07, 2021
4 May 29, 2022
2 Nov 03, 2021
6 Jul 14, 2022
2 May 10, 2022
8 Oct 02, 2022
14 Oct 17, 2022
138 Dec 15, 2022
107 Dec 21, 2022
4 Aug 04, 2022
450 Jan 05, 2023
96 Dec 16, 2022
21 Nov 18, 2022
2 Nov 21, 2021
2 Apr 03, 2022
15 Jul 28, 2021