Merge pull request #25 from DataCrunch-io/update-publish-steps-and-fi…

…x-typo Update publish steps and fix typo
DataCrunch-io · Nov 25, 2024 · 5972c1b · 5972c1b
2 parents ace9a27 + dc45334
commit 5972c1b
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 6 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -64,6 +64,14 @@ Release Guidelines
 ------------------------
 Some steps for releasing a new version:
 
-1. Update the version in `__version__.py`
+1. Update the version in ``__version__.py``
 2. Add an entry to the CHANGELOG.rst file
-3. Push the changes to the `master` branch and add a new release tag.
+3. ``git tag vX.Y.Z``
+4. ``git push master``
+5. ``git push --tags``
+6. `Draft and publish`_ a new release.
+7. Check that package is automatically published to `PyPI`_ via `GitHub action`_.
+
+.. _Draft and publish: https://github.com/DataCrunch-io/datacrunch-python/releases
+.. _PyPI: https://pypi.org/project/datacrunch/
+.. _GitHub action: https://github.com/DataCrunch-io/datacrunch-python/actions/workflows/publish_package.yml
diff --git a/docs/source/examples/advanced_create_instance.rst b/docs/source/examples/advanced_create_instance.rst
@@ -60,7 +60,7 @@ Advanced Create Instance
                                                         ssh_key_ids=ssh_keys_ids,
                                                         hostname='example',
                                                         description='large instance'
-                                                        os_volumes={
+                                                        os_volume={
                                                             "name": "Large OS volume",
                                                             "size": 95
                                                         })

diff --git a/docs/source/examples/instances_and_volumes.rst b/docs/source/examples/instances_and_volumes.rst
@@ -42,7 +42,7 @@ Instances and Volumes
                                                           ssh_key_ids=ssh_keys,
                                                           hostname='example',
                                                           description='example instance',
-                                                          os_volumes={
+                                                          os_volume={
                                                               "name": "OS volume",
                                                               "size": 95
                                                           })

diff --git a/examples/advanced_create_instance.py b/examples/advanced_create_instance.py
@@ -55,7 +55,7 @@
                                                        ssh_key_ids=ssh_keys_ids,
                                                        hostname='example',
                                                        description='large instance',
-                                                       os_volumes={
+                                                       os_volume={
                                                             "name": "Large OS volume",
                                                             "size": 95
                                                         })

diff --git a/examples/instances_and_volumes.py b/examples/instances_and_volumes.py
@@ -36,7 +36,7 @@
                                                           ssh_key_ids=ssh_keys,
                                                           hostname='example',
                                                           description='example instance',
-                                                          os_volumes={
+                                                          os_volume={
                                                               "name": "OS volume",
                                                               "size": 95
                                                           })