Skip to content

Commit b49957d

Browse files
authored
MRG: Merge pull request #595 from octue/remove-special-treatment-of-latest-tag
Remove special treatment of `latest` revision tag
2 parents 622dd2c + 77a7365 commit b49957d

14 files changed

+437
-287
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,7 @@ repos:
6262
- id: check-branch-name
6363
args:
6464
- "^main$"
65-
- "^development$"
66-
- "^devops/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
67-
- "^doc/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
68-
- "^feature/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
69-
- "^enhancement/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
70-
- "^fix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
71-
- "^hotfix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
72-
- "^review/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
73-
- "^refactor/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
74-
- "^test/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
75-
- "^style/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
76-
- "^deprecation/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
77-
- "^dependencies/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
65+
- "^([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
7866

7967
- repo: https://github.com/octue/conventional-commits
8068
rev: 0.9.0

docs/source/asking_questions.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ and/or an input manifest.
1515
from octue.resources import Child
1616
1717
child = Child(
18-
id="my-organisation/my-service:latest",
18+
id="my-organisation/my-service:2.1.7",
1919
backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
2020
)
2121
@@ -31,15 +31,15 @@ and/or an input manifest.
3131
>>> <FilterSet({<Datafile('my_file.csv')>, <Datafile('another_file.csv')>})>
3232
3333
34-
.. _using_latest_revision_tag:
34+
.. _using_default_revision_tag:
3535

3636
.. note::
3737

38-
Using the ``latest`` service revision tag, or not including one at all, will cause your question to be sent to the
39-
latest deployed revision of the service. This is determined by making a request to a `service registry
40-
<https://django-twined.readthedocs.io/en/latest/>`_ if one or more :ref:`registries are defined
41-
<using_service_registries>`. If none of the service registries contain an entry for this service, a specific service
42-
revision tag must be used.
38+
Not including a service revision tag will cause your question to be sent to the default revision of the service
39+
(usually the latest deployed version). This is determined by making a request to a `service registry
40+
<https://django-twined.readthedocs.io/en/latest/>`_ if one or more
41+
:ref:`registries are defined <using_service_registries>`. If none of the service registries contain an entry for
42+
this service, a specific service revision tag must be used.
4343

4444
You can also set the following options when you call :mod:`Child.ask <octue.resources.child.Child.ask>`:
4545

@@ -100,15 +100,15 @@ if your app configuration file is:
100100
"children": [
101101
{
102102
"key": "wind_speed",
103-
"id": "template-child-services/wind-speed-service:latest",
103+
"id": "template-child-services/wind-speed-service:2.1.1",
104104
"backend": {
105105
"name": "GCPPubSubBackend",
106106
"project_name": "my-project"
107107
}
108108
},
109109
{
110110
"key": "elevation",
111-
"id": "template-child-services/elevation-service:latest",
111+
"id": "template-child-services/elevation-service:3.1.9",
112112
"backend": {
113113
"name": "GCPPubSubBackend",
114114
"project_name": "my-project"
@@ -161,15 +161,15 @@ For example, if the child requires these children in its app configuration:
161161
[
162162
{
163163
"key": "wind_speed",
164-
"id": "template-child-services/wind-speed-service:latest",
164+
"id": "template-child-services/wind-speed-service:2.1.1",
165165
"backend": {
166166
"name": "GCPPubSubBackend",
167167
"project_name": "octue-sdk-python"
168168
},
169169
},
170170
{
171171
"key": "elevation",
172-
"id": "template-child-services/elevation-service:latest",
172+
"id": "template-child-services/elevation-service:3.1.9",
173173
"backend": {
174174
"name": "GCPPubSubBackend",
175175
"project_name": "octue-sdk-python"
@@ -186,15 +186,15 @@ then you can override them like this:
186186
children=[
187187
{
188188
"key": "wind_speed",
189-
"id": "my/own-service:latest",
189+
"id": "my/own-service:1.0.0",
190190
"backend": {
191191
"name": "GCPPubSubBackend",
192192
"project_name": "octue-sdk-python"
193193
},
194194
},
195195
{
196196
"key": "elevation",
197-
"id": "organisation/another-service:latest",
197+
"id": "organisation/another-service:0.1.0",
198198
"backend": {
199199
"name": "GCPPubSubBackend",
200200
"project_name": "octue-sdk-python"
@@ -244,7 +244,7 @@ You can specify service registries in two ways:
244244
.. code-block:: python
245245
246246
child = Child(
247-
id="my-organisation/my-service:latest",
247+
id="my-organisation/my-service:1.1.0",
248248
backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
249249
service_registries=[
250250
{"name": "my-registry", "endpoint": "blah.com/services"},

0 commit comments

Comments
 (0)