Merge pull request #16 from crim-ca/stac-model-release

stac-model release workflow, new stac-model-release, align release on pypi and in .toml

.github/workflows/publish.yaml

@@ -1,9 +1,10 @@
-name: Publish JSON Schema
+name: Publish JSON Schema or stac-model package via Github Release
 on:
   release:
     types: [published]
 jobs:
-  deploy:
+  deploy-schema:
+    if: startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
     steps:
       - name: Inject env variables
@@ -14,4 +15,18 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: json-schema
-          destination_dir: ${{ env.GITHUB_REF_SLUG }}
+          destination_dir: ${{ env.GITHUB_REF_SLUG }}
+  publish-pypi:
+    if: startsWith(github.ref, 'refs/tags/stac-model-v')
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/[email protected]
+      with:
+        python-version: 3.10
+    - name: Install poetry
+      run: make poetry-install
+    - name: Build and publish
+      run: |
+        make publish

CHANGELOG.md

@@ -12,20 +12,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   the [Item Assets](https://github.com/stac-extensions/item-assets) extension, as mentioned this specification.
 
 ### Changed
-- n/a
+- Adds a job to publish.yaml to publish the stac-model package
 
 ### Deprecated
 - n/a
 
 ### Removed
 - Field `mlm:name` requirement to be unique. There is no way to guarantee this from a single Item's definition
-  and their JSON schema validation. For uniqueness requirement, users should instead rely on the `id` property  
+  and their JSON schema validation. For uniqueness requirement, users should instead rely on the `id` property
   of the Item, which is ensured to be unique under the corresponding Collection, since it would not be retrievable
   otherwise (i.e.: `collections/{collectionID}/items/{itemID}`).
 
 ### Fixed
 - Fix the validation strategy of the `mlm:model` role required by at least one Asset under a STAC Item.
   Although the role requirement was validated, the definition did not allow for other Assets without it to exist.
+- correct `stac-model` version in code and publish matching release on pypi
 
 ## [v1.1.0](https://github.com/crim-ca/mlm-extension/tree/v1.1.0)
 
@@ -69,7 +70,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `disk_size` replaced by `file:size` (see [Best Practices - File Extension](best-practices.md#file-extension))
 - `memory_size` under `dlm:architecture` moved directly under Item properties as `mlm:memory_size`
 - replaced all hardware/accelerator/runtime definitions into distinct `mlm` fields directly under the
-  STAC Item properties (top-level, not nested) to allow better search support by STAC API. 
+  STAC Item properties (top-level, not nested) to allow better search support by STAC API.
 - reorganized `dlm:architecture` nested fields to exist at the top level of properties as `mlm:name`, `mlm:summary`
   and so on to provide STAC API search capabilities.
 - replaced `normalization:mean`, etc. with [statistics](./README.md#bands-and-statistics) from STAC 1.1 common metadata

CONTRIBUTING.md

@@ -8,7 +8,7 @@
 make poetry-install
 ```
 
-> This installs Poetry as a [standalone application][poetry-install]. 
+> This installs Poetry as a [standalone application][poetry-install].
 > If you prefer, you can simply install it inside your virtual environment.
 
 2. Initialize project dependencies with poetry and install `pre-commit` hooks:
@@ -24,7 +24,7 @@ To activate your `virtualenv` run `poetry shell`.
 
 Want to know more about Poetry? Check [its documentation][poetry-docs].
 
-Poetry's [commands][poetry-cli] let you easily make descriptive python environments 
+Poetry's [commands][poetry-cli] let you easily make descriptive python environments
 and run commands in those environments, like:
 
 - `poetry add numpy@latest`
@@ -51,7 +51,7 @@ make test
 git checkout -b your-branch
 git add .
 git commit -m ":tada: Initial commit"
-git remote add origin https://github.com/your-fork/stac-model.git
+git remote add origin https://github.com/your-fork/mlm-extension.git
 git push -u origin your-branch
 ```
 

Makefile

@@ -20,6 +20,10 @@ poetry-plugins:
 poetry-env:
 	poetry config virtualenvs.in-project true
 
+.PHONY: publish
+publish:
+	poetry publish --build
+
 #* Installation
 .PHONY: install
 install: poetry-env