Skip to content

Commit

Permalink
docs: prepare release (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
brutasse authored Apr 29, 2024
1 parent dfec096 commit cef6d35
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Install and build
run: |
python -VV
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ jobs:
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: "Install dependencies"
Expand All @@ -40,8 +40,8 @@ jobs:
name: Linting
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: "Install dependencies"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Fetch latest OpenAPI definition
shell: bash
run: |-
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pypi-package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: hynek/build-and-inspect-python-package@v1
- uses: hynek/build-and-inspect-python-package@v2

release-pypi:
name: Upload package to pypi.org
Expand All @@ -27,7 +27,7 @@ jobs:
environment: release
steps:
- name: Download packages built by previous step
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: Packages
path: dist
Expand Down
20 changes: 18 additions & 2 deletions docs/changes.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,35 @@
Changelog
---------

0.9.0 (unreleased)
0.10.0 (unreleased)
~~~~~~~~~~~~~~~~~~~

0.9.0 (2024-04-29)
~~~~~~~~~~~~~~~~~~

``exoscale.api.v2.Client`` improvements:

* Client initialization accepts two signatures: ``Client(key, secret, zone)`` for
typical use and ``Client(key, secret, url)`` when needing to target another
endpoint than the public endpoint template.
* Drop support for Python 3.7, add Python 3.12 to the testing matrix.
* Fix operations with multiple path parameters (`@thomas-chauvet https://github.com/exoscale/python-exoscale/pull/57`)
* API changes and additions:
* DBaaS:
* integrations settings
* Split secrets over to separate endpoints
* Add zone to service details
* DNS record types cleanup
* Instance password reset operation
* Provide ``at-vie-2`` in the zones choices
* Block Storage operations and CSI addon
* Audit-trail format adjustments
* Add MAC address to private network attachments

0.8.0 (2023-05-11)
~~~~~~~~~~~~~~~~~~

- Add `exoscale.api.v2.Client`: a low-level API client targeting the Exoscale
- Add ``exoscale.api.v2.Client``: a low-level API client targeting the Exoscale
V2 API.

0.7.1 (2021-10-18)
Expand Down
6 changes: 3 additions & 3 deletions exoscale/api/v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,9 +194,9 @@ def _return_docstring(operation):
desc += f". Values are ``{choices}``"
suffix = f": {desc}" if desc else ""
normalized_name = name.replace("-", "_")
body[
normalized_name
] = f"**{normalized_name}** ({typ}){suffix}."
body[normalized_name] = (
f"**{normalized_name}** ({typ}){suffix}."
)

doc = (
f"dict: {ref['description']}. A dictionnary with the following keys:"
Expand Down

0 comments on commit cef6d35

Please sign in to comment.