Skip to content

Commit dfeda11

Browse files
committed
DOC: Add file tree to creating services guide
skipci
1 parent adfa1a2 commit dfeda11

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/getting_started/creating_services.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ Now install the dependencies:
6969
poetry install
7070
```
7171

72+
Note that this will create a `poetry.lock` file with the locked dependency versions in. Keep this file.
73+
7274
## Write the service python code
7375

7476
We'll make the example service do the most basic thing possible - return dummy output values and a dummy output dataset.
@@ -171,7 +173,7 @@ Go back to your repository on GitHub and open [its Actions settings](https://doc
171173
## Add the GitHub Actions release workflow
172174
173175
A GitHub Actions reusable workflow is used to automatically deploy the service when its code is merged into `main`.
174-
Create a file called `.github/workflows/release.yml` and add the following, replacing `<handle>` and
176+
Create a file called `.github/workflows/deploy.yml` and add the following, replacing `<handle>` and
175177
`<gcp-project-id>` as before:
176178

177179
```yaml
@@ -202,6 +204,24 @@ jobs:
202204
See [here](https://github.com/octue/workflows?tab=readme-ov-file#deploying-a-kuberneteskueue-octue-twined-service-revision)
203205
for more information, including how to use custom dockerfiles for your service.
204206

207+
## Check your files
208+
209+
Once you've finished the steps above, your repository should have a file structure like this:
210+
211+
```
212+
.
213+
├── .github
214+
│ └── workflows
215+
│ └── deploy.yml
216+
├── example_service
217+
│ ├── __init__.py
218+
│ └── app.py
219+
├── octue.yaml
220+
├── poetry.lock
221+
├── pyproject.toml
222+
└── twine.json
223+
```
224+
205225
## Merge the code into `main`
206226

207227
To deploy the service, we need to merge the code we've added into the `main` branch. Make sure any sensitive and

0 commit comments

Comments
 (0)