Skip to content

Commit 9d7c8b2

Browse files
feat: add README content as setup's long description
- add action step to create a new github release - bump version to 0.1.2
1 parent 4e50f08 commit 9d7c8b2

File tree

7 files changed

+31
-10
lines changed

7 files changed

+31
-10
lines changed

.github/workflows/publish.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,22 @@ jobs:
3131
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
3232
run: |
3333
python -m twine upload dist/*
34+
35+
- name: Get version from setup.py
36+
id: package-version
37+
run: |
38+
VERSION=$(grep "VERSION = " setup.py | cut -d'"' -f2)
39+
if [ -z "$VERSION" ]; then
40+
echo "Error: Could not extract version from setup.py"
41+
exit 1
42+
fi
43+
echo "current-version=$VERSION" >> $GITHUB_OUTPUT
44+
45+
- name: Create GitHub Release
46+
uses: softprops/action-gh-release@v1
47+
with:
48+
tag_name: v${{ steps.package-version.outputs.current-version }}
49+
name: v${{ steps.package-version.outputs.current-version }}
50+
draft: false
51+
prerelease: false
52+
generate_release_notes: true

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Visit our quick start guide and full API documentation at [developers.plane.so](
66
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
77

88
- API version: 0.0.1
9-
- Package version: 0.1.1
9+
- Package version: 0.1.2
1010
- Generator version: 7.13.0
1111
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
1212
For more information, please visit [https://plane.so](https://plane.so)

plane/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
""" # noqa: E501
1616

1717

18-
__version__ = "0.1.1"
18+
__version__ = "0.1.2"
1919

2020
# import apis into sdk package
2121
from plane.api.assets_api import AssetsApi

plane/api_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
7878
self.default_headers[header_name] = header_value
7979
self.cookie = cookie
8080
# Set default User-Agent.
81-
self.user_agent = 'OpenAPI-Generator/0.1.1/python'
81+
self.user_agent = 'OpenAPI-Generator/0.1.2/python'
8282
self.client_side_validation = configuration.client_side_validation
8383

8484
def __enter__(self):

plane/configuration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ def to_debug_report(self):
412412
"OS: {env}\n"\
413413
"Python Version: {pyversion}\n"\
414414
"Version of the API: 0.0.1\n"\
415-
"SDK Package Version: 0.1.1".\
415+
"SDK Package Version: 0.1.2".\
416416
format(env=sys.platform, pyversion=sys.version)
417417

418418
def get_host_settings(self):

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "plane"
3-
version = "0.1.1"
3+
version = "0.1.2"
44
description = "The Plane REST API"
55
authors = ["Plane <[email protected]>"]
66
license = "GNU AGPLv3"

setup.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
# prerequisite: setuptools
2323
# http://pypi.python.org/pypi/setuptools
2424
NAME = "plane-sdk"
25-
VERSION = "0.1.1"
25+
VERSION = "0.1.2"
2626
PYTHON_REQUIRES = ">=3.7"
2727
REQUIRES = [
2828
"urllib3 >= 1.25.3, < 3.0.0",
@@ -31,21 +31,23 @@
3131
"aenum"
3232
]
3333

34+
# Read README.md for long description
35+
with open("README.md", "r", encoding="utf-8") as fh:
36+
long_description = fh.read()
37+
3438
setup(
3539
name=NAME,
3640
version=VERSION,
3741
description="The Plane REST API",
3842
author="Plane",
3943
author_email="[email protected]",
4044
url="",
41-
keywords=["OpenAPI", "OpenAPI-Generator", "The Plane REST API"],
45+
keywords=["The Plane REST API"],
4246
install_requires=REQUIRES,
4347
packages=find_packages(exclude=["test", "tests"]),
4448
include_package_data=True,
4549
license="GNU AGPLv3",
4650
long_description_content_type='text/markdown',
47-
long_description="""\
48-
The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
49-
""", # noqa: E501
51+
long_description=long_description,
5052
package_data={"plane": ["py.typed"]},
5153
)

0 commit comments

Comments
 (0)