Skip to content

Commit 6031c75

Browse files
author
SachinVarghese
committed
Update readme
1 parent 3e6c837 commit 6031c75

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ There is some custom logic added on top of each client.
6464
These extra files and customisation can be found in the
6565
[`./templates`](./templates) folder.
6666

67+
For Seldon Deploy model metadata service, we are having to patch two additional dict type parameters namely `tags` and `metrics` to the generated docs and sdk code. We do this manually, using the same make command, by applying the [patch file](./templates/python/metadata_tags_metrics.patch) file to the code, post sdk generation task. In some cases the patch apply cmd may fail, and there might be a requirement to re-generate the patch manually by changing the generated docs/sdk files as required.
68+
6769
### How to create a new release?
6870

6971
1. Update the [swagger file](./swagger-v1alpha1.yml) with latest specification.
7072
2. Update [config file](./config/python.json) to bump the package version.
71-
3. Run `make python` to re-generate the sdk api files from new specifications.
72-
73-
**Note** : For Seldon Deploy model metadata service, we are having to patch two additional dict type parameters namely `tags` and `metrics` to the generated docs and sdk code. We do this manually, using the same make command, by applying the [patch file](./templates/python/metadata_tags_metrics.patch) file to the code, post sdk generation task. In some cases the patch apply cmd may fail, and there might be a requirement to re-generate the patch manually by changing the generated docs/sdk files as required.
73+
3. Run `make python` to re-generate the sdk api files from new specifications. If you get error `error: patch failed` then update the template customisation [patch file](./templates/python/metadata_tags_metrics.patch). See templates section above for more details.
7474

7575
4. Run `make -C build push` to build & push latest release to [PyPi](https://pypi.org/project/seldon-deploy-sdk/)
7676
5. Create a new Github Tag and Release with latest version and notes.

0 commit comments

Comments
 (0)