Skip to content

Commit f76ba1d

Browse files
committed
Change README to reflect new workflow
Signed-off-by: Danny Chiao <danny@tecton.ai>
1 parent 41786bd commit f76ba1d

3 files changed

Lines changed: 71 additions & 2 deletions

File tree

.github/workflows/feast_apply.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feast apply
2+
3+
on: [push]
4+
5+
jobs:
6+
feast_apply:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Setup Python
10+
id: setup-python
11+
uses: actions/setup-python@v2
12+
with:
13+
python-version: "3.7"
14+
architecture: x64
15+
- name: Set up AWS SDK
16+
uses: aws-actions/configure-aws-credentials@v1
17+
with:
18+
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
19+
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
20+
aws-region: us-west-2
21+
22+
# Run `feast apply`
23+
- uses: actions/checkout@v2
24+
- name: Install feast
25+
run: pip install "feast[aws]"
26+
- name: Run feast apply
27+
env:
28+
FEAST_USAGE: "False"
29+
IS_TEST: "True"
30+
run: |
31+
cd module_0/feature_repo_aws
32+
feast apply

.github/workflows/feast_plan.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Feast plan
22

3-
on: [pull_request] # Should be triggered once then manually if possible
3+
on: [pull_request]
44

55
jobs:
66
feast_plan:

module_0/README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ We recommend automatically running `feast plan` on incoming PRs to describe what
152152
- This is useful for helping PR reviewers understand the effects of a change.
153153
- One example is whether a PR may change features that are already depended on in production by another model (e.g. `FeatureService`).
154154

155-
An example GitHub workflow (See [feast_plan.yml](../.github/workflows/feast_plan.yml), which is setup in this workshop repo)
155+
An example GitHub workflow that runs `feast plan` on PRs (See [feast_plan.yml](../.github/workflows/feast_plan.yml), which is setup in this workshop repo)
156156

157157
```yaml
158158
name: Feast plan
@@ -215,6 +215,43 @@ Registered feature view driver_hourly_stats
215215
Deploying infrastructure for driver_hourly_stats
216216
```
217217

218+
An example GitHub workflow which runs `feast apply` on PR merge (See [feast_apply.yml](../.github/workflows/feast_apply.yml), which is setup in this workshop repo)
219+
220+
```yaml
221+
name: Feast apply
222+
223+
on: [push]
224+
225+
jobs:
226+
feast_apply:
227+
runs-on: ubuntu-latest
228+
steps:
229+
- name: Setup Python
230+
id: setup-python
231+
uses: actions/setup-python@v2
232+
with:
233+
python-version: "3.7"
234+
architecture: x64
235+
- name: Set up AWS SDK
236+
uses: aws-actions/configure-aws-credentials@v1
237+
with:
238+
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
239+
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
240+
aws-region: us-west-2
241+
242+
# Run `feast apply`
243+
- uses: actions/checkout@v2
244+
- name: Install feast
245+
run: pip install "feast[aws]"
246+
- name: Run feast apply
247+
env:
248+
FEAST_USAGE: "False"
249+
IS_TEST: "True"
250+
run: |
251+
cd module_0/feature_repo_aws
252+
feast apply
253+
```
254+
218255
### Step 3 (optional): Access control for the registry
219256
We don't dive into this deeply, but you don't want to allow arbitrary users to clone the feature repository, change definitions and run `feast apply`. Thus, you should lock down your registry (e.g. with an S3 bucket policy) to only allow changes from your CI/CD user and perhaps some ML engineers.
220257

0 commit comments

Comments
 (0)