Skip to content

Commit 9efe560

Browse files
committed
Add README.
1 parent 5c0f685 commit 9efe560

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# GolangNetlifyFunctions
2-
How to deploy multiple golang Netlify functions without a frontend.
2+
3+
# Purpose
4+
Netlify's documentation on deploying multiple Golang functions has a few pain points. First, deploying multiple functions on their system without the constant need to update the Makefile as this [example](https://github.com/netlify/aws-lambda-go-example) would have required. Second, deploying without a frontend introduces some small changes. This example attempts to streamline Netlify's already easy-to-use deployment system even further.
5+
6+
# Assumptions
7+
This example makes a few assumptions about the Netlify deployment system to make this low-maintenance solution work:
8+
1. Netlify's build repo root will always be: /opt/build/repo
9+
2. Your Netlify functions folder will be called: functions
10+
11+
# How to deploy this example...
12+
*The following assumes you have a Netlify account authorized to access your GitHub repos.
13+
14+
1. Fork this repo. TODO Insert Link to Forking
15+
1. Change your GIT_IMPORT_PATH to your forked repo's URL.
16+
1. Change the name of your functions folder in the netlify.toml.
17+
- If you make this change, be sure to change this appropriately. For instance, if your functions folder name is llama, you should change this line to: GOBIN=/opt/build/repo/llama.
18+
1. Go to app.netlify.com to login.
19+
1. Click on "New site from Git".
20+
1. Select "GitHub".
21+
1. Select or Find "GolangNetlifyFunctions" from the list.
22+
1. Ensure the "Branch to deploy" drop-down field is set to master.
23+
1. Click on "Deploy site".
24+
1. Click on "Deploys" tab at the top of the page.
25+
1. Wait for the first entry to change its status to: PUBLISHED.
26+
1. Click on "Functions" tab at the top of the page.
27+
1. You should see one function for "hello" and another for "goodbye".
28+
1. If you click on either one, and visit the URL <insert url here>, you will see either the words "Hello, World!" or "Goddbye, World!"
29+
1. Congratulations, you've just deployed a pure backend filled with Golang Netlify functions!
30+
31+
# How do I add more functions to this...
32+
Simply create a directory on the first level of this repo, next to the "hello" and "goodbye" directories, and fill it with go files! This setup takes care of the rest!!! Have fun!
33+
34+
# References
35+
* [Publishing a Golang Netlify Function](https://www.netlify.com/docs/functions/#go-lambda-functions)
36+
* [netlify.toml Reference](https://www.netlify.com/docs/netlify-toml-reference/)

0 commit comments

Comments
 (0)