MRG: Merge pull request #533 from octue/devops/remove-git-mkver-file

Remove `mkver.conf` file and update troubleshooting docs

Author: cortadocodes

.github/workflows/python-ci.yml

@@ -19,9 +19,10 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - uses: octue/[email protected]1
+      - uses: octue/[email protected]3
         with:
-          version_source_type: pyproject.toml
+          path: pyproject.toml
+          breaking_change_indicated_by: minor
 
   run-tests:
     if: "!contains(github.event.head_commit.message, 'skipci')"

.github/workflows/update-pull-request.yml

@@ -18,12 +18,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: octue/[email protected]
+    - uses: octue/[email protected]
+      id: pr-description
       with:
         pull_request_url: ${{ github.event.pull_request.url }}
         api_token: ${{ secrets.GITHUB_TOKEN }}
     - name: Update pull request body
       uses: riskledger/update-pr-description@v2
       with:
-        body: ${{ env.PULL_REQUEST_DESCRIPTION }}
+        body: ${{ steps.pr-description.outputs.pull_request_description }}
         token: ${{ secrets.GITHUB_TOKEN }}

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
-exclude: 'build|.git/|.tox|dist|octue.egg-info'
+exclude: "build|.git/|.tox|dist|octue.egg-info"
 default_stages: [commit]
 fail_fast: true
 default_language_version:
-  python: python3  # force all unspecified python hooks to run python3
+  python: python3 # force all unspecified python hooks to run python3
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.3.0
@@ -21,55 +21,60 @@ repos:
     rev: 22.6.0
     hooks:
       - id: black
-        args: ['--line-length', '120']
+        args: ["--line-length", "120"]
 
   - repo: https://gitlab.com/pycqa/flake8
     rev: 3.9.2
     hooks:
       - id: flake8
         language_version: python3
         additional_dependencies:
-          - 'pep8-naming'
+          - "pep8-naming"
         args:
           - --ignore-names=setUp,tearDown,setUpClass,tearDownClass,asyncSetUp,asyncTearDown,setUpTestData,failureException,longMessage,maxDiff,startTestRun,stopTestRun
 
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
+    hooks:
+      - id: prettier
+
   - repo: https://github.com/pycqa/pydocstyle
     rev: 6.1.1
     hooks:
-    - id: pydocstyle
+      - id: pydocstyle
 
   - repo: https://github.com/thclark/pre-commit-sphinx
     rev: 0.0.3
     hooks:
       - id: build-docs
         language_version: python3
         additional_dependencies:
-          - 'poetry==1.2.0b2'
-          - 'Sphinx>=4,<5'
-          - 'sphinx-rtd-theme>=1,<2'
-          - 'sphinx-tabs>=3,<4'
-          - 'sphinx-toolbox==3.0.0'
-          - 'git+https://github.com/octue/octue-sdk-python.git@main'
+          - "poetry==1.2.0b2"
+          - "Sphinx>=4,<5"
+          - "sphinx-rtd-theme>=1,<2"
+          - "sphinx-tabs>=3,<4"
+          - "sphinx-toolbox==3.0.0"
+          - "git+https://github.com/octue/octue-sdk-python.git@main"
 
   - repo: https://github.com/windpioneers/pre-commit-hooks
     rev: 0.0.5
     hooks:
       - id: check-branch-name
         args:
-          - '^main$'
-          - '^development$'
-          - '^devops/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^doc/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^feature/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^enhancement/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^fix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^hotfix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^review/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^refactor/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^test/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^style/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^deprecation/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^dependencies/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
+          - "^main$"
+          - "^development$"
+          - "^devops/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^doc/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^feature/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^enhancement/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^fix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^hotfix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^review/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^refactor/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^test/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^style/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^deprecation/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
+          - "^dependencies/([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
 
   - repo: https://github.com/octue/conventional-commits
     rev: 0.8.1

docs/source/asking_questions.rst

@@ -47,7 +47,7 @@ input values and/or an input manifest.
     from octue.resources import Child
 
     child = Child(
-        id="my-organisation/my-service",
+        id="my-organisation/my-service:latest",
         backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
     )
 
@@ -122,15 +122,15 @@ if your app configuration file is:
       "children": [
         {
           "key": "wind_speed",
-          "id": "template-child-services/wind-speed-service",
+          "id": "template-child-services/wind-speed-service:latest",
           "backend": {
             "name": "GCPPubSubBackend",
             "project_name": "my-project"
           }
         },
         {
           "key": "elevation",
-          "id": "template-child-services/elevation-service",
+          "id": "template-child-services/elevation-service:latest",
           "backend": {
             "name": "GCPPubSubBackend",
             "project_name": "my-project"
@@ -183,15 +183,15 @@ For example, if the child requires these children in its app configuration:
     [
         {
             "key": "wind_speed",
-            "id": "template-child-services/wind-speed-service",
+            "id": "template-child-services/wind-speed-service:latest",
             "backend": {
                 "name": "GCPPubSubBackend",
                 "project_name": "octue-amy"
             },
         },
         {
             "key": "elevation",
-            "id": "template-child-services/elevation-service",
+            "id": "template-child-services/elevation-service:latest",
             "backend": {
                 "name": "GCPPubSubBackend",
                 "project_name": "octue-amy"
@@ -208,15 +208,15 @@ then you can override them like this:
         children=[
             {
                 "key": "wind_speed",
-                "id": "my/own-service",
+                "id": "my/own-service:latest",
                 "backend": {
                     "name": "GCPPubSubBackend",
                     "project_name": "octue-amy"
                 },
             },
             {
                 "key": "elevation",
-                "id": "organisation/another-service",
+                "id": "organisation/another-service:latest",
                 "backend": {
                     "name": "GCPPubSubBackend",
                     "project_name": "octue-amy"

docs/source/creating_services.rst

@@ -115,7 +115,7 @@ octue.yaml
 
             services:
               - namespace: my-organisation
-              - name: my-app
+                name: my-app
 
         It may also need the following key-value pairs: