Skip to content

Commit 584e2a4

Browse files
Update README.md
1 parent 0ba43c4 commit 584e2a4

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ env:
4444
CODE_ENGINE_REGION: "us-south"
4545
CODE_ENGINE_PROJECT: "Code Engine Project Name"
4646
WORKLOAD_NAME: "my-cool-app"
47+
RESOURCE_GROUP: "my-resource-group"
4748

4849
jobs:
4950

@@ -54,18 +55,18 @@ jobs:
5455
uses: actions/checkout@v3
5556

5657
- name: Deploy Application to Code Engine
57-
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v1
58+
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v2
5859
with:
5960
ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
60-
resource_group: 'Default'
61+
resource_group: ${{ env.RESOURCE_GROUP }}
6162
code_engine_region: ${{ env.CODE_ENGINE_REGION }}
6263
code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
6364
workload_type: 'app'
6465
workload_name: ${{ env.WORKLOAD_NAME }}
6566
workload_port: 8080
6667
build_source: './app-code'
67-
cpu: 1
68-
memory: 4G
68+
workload_cpu: 1
69+
workload_memory: 4G
6970
```
7071
7172
### Job Workload
@@ -82,51 +83,64 @@ env:
8283
CODE_ENGINE_REGION: "us-south"
8384
CODE_ENGINE_PROJECT: "Code Engine Project Name"
8485
WORKLOAD_NAME: "etl-job"
86+
RESOURCE_GROUP: "my-resource-group"
8587

88+
jobs:
8689
code-engine-job:
8790
runs-on: ubuntu-latest
8891
steps:
8992
- name: Check out code
9093
uses: actions/checkout@v3
9194

9295
- name: Deploy Job to Code Engine
93-
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v1
96+
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v2
9497
with:
9598
ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
96-
resource_group: 'Default'
99+
resource_group: ${{ env.RESOURCE_GROUP }}
97100
code_engine_region: ${{ env.CODE_ENGINE_REGION }}
98101
code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
99102
workload_type: 'job'
100103
workload_name: ${{ env.WORKLOAD_NAME }}
101104
build_source: './job-code'
102-
cpu: 1
103-
memory: 4G
105+
workload_cpu: 1
106+
workload_memory: 4G
104107
```
105108
106109
### Function Workload
107110
108111
Code Engine currently supports nodejs (`nodejs-18`) and python (`python-3.11`) for serverless functions. This is set with the `function_runtime` input.
109112

110113
```yaml
114+
name: Create or update Code Engine serverless function
115+
116+
on:
117+
push:
118+
branches:
119+
- main
120+
env:
121+
CODE_ENGINE_REGION: "us-south"
122+
CODE_ENGINE_PROJECT: "Code Engine Project Name"
123+
WORKLOAD_NAME: "webhook-fn"
124+
RESOURCE_GROUP: "my-resource-group"
125+
126+
jobs:
111127
code-engine-fn-js:
112128
runs-on: ubuntu-latest
113129
steps:
114130
- name: Check out code
115131
uses: actions/checkout@v3
116132
117133
- name: Deploy nodejs based function to Code Engine
118-
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v1
134+
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v2
119135
with:
120136
ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
121-
resource_group: 'Default'
137+
resource_group: ${{ env.RESOURCE_GROUP }}
122138
code_engine_region: ${{ env.CODE_ENGINE_REGION }}
123139
code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
124140
workload_type: 'fn'
125141
function_runtime: 'nodejs-18'
126142
workload_name: ${{ env.WORKLOAD_NAME }}
127143
build_source: './fn-js-code'
128-
cpu: 1
129-
memory: 4G
130144
131145
code-engine-fn-py:
132146
runs-on: ubuntu-latest
@@ -135,18 +149,18 @@ Code Engine currently supports nodejs (`nodejs-18`) and python (`python-3.11`) f
135149
uses: actions/checkout@v3
136150
137151
- name: Deploy python based function to Code Engine
138-
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v1
152+
uses: cloud-design-dev/ibmcloud-code-engine-github-action@v2
139153
with:
140154
ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
141-
resource_group: 'Default'
155+
resource_group: ${{ env.RESOURCE_GROUP }}
142156
code_engine_region: ${{ env.CODE_ENGINE_REGION }}
143157
code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
144158
workload_type: 'fn'
145159
function_runtime: 'python-3.11'
146160
workload_name: ${{ env.WORKLOAD_NAME }}
147161
build_source: './fn-python-code'
148-
cpu: 1
149-
memory: 4G
162+
workload_cpu: 1
163+
workload_memory: 4G
150164
```
151165

152166
This action is not officially endorsed by IBM Cloud but can be used as a community-contributed GitHub Action.

0 commit comments

Comments
 (0)