From 0b4828687da7a34bdecf9d27322995eccd6e5628 Mon Sep 17 00:00:00 2001 From: Alexey Shamrin Date: Thu, 21 Nov 2024 18:22:49 +0200 Subject: [PATCH 1/3] update publishing instructions in CONTRIBUTING.md --- CONTRIBUTING.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5d3a6d9..3610936 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -66,4 +66,12 @@ Some steps for releasing a new version: 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. \ No newline at end of file +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 From 6ddce70cc554a48566c5ae6202ee107d4817d26a Mon Sep 17 00:00:00 2001 From: Alexey Shamrin Date: Thu, 21 Nov 2024 18:24:21 +0200 Subject: [PATCH 2/3] fix typo fixes #22 --- docs/source/examples/advanced_create_instance.rst | 2 +- docs/source/examples/instances_and_volumes.rst | 2 +- examples/advanced_create_instance.py | 2 +- examples/instances_and_volumes.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/examples/advanced_create_instance.rst b/docs/source/examples/advanced_create_instance.rst index b30f70a..880effd 100644 --- 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 index b835a4a..6701c4c 100644 --- 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 index 0364850..564b032 100644 --- 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 index 2c48e55..369b5b3 100644 --- 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 }) From dc4533473c3943c0bfeaa12f1920544302af8389 Mon Sep 17 00:00:00 2001 From: Alexey Shamrin Date: Thu, 21 Nov 2024 18:32:34 +0200 Subject: [PATCH 3/3] fix ReST --- CONTRIBUTING.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3610936..8622059 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -64,11 +64,11 @@ 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. `git tag vX.Y.Z` -4. `git push master` -5. `git push --tags` +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`_.