Skip to content

Commit 54c49e2

Browse files
authored
Merge pull request #946 from cderici/cleanup-release-process-3.x
#946 #### Description This clears up the release process for the master branch. Apparently I forgot to forward port some of the changes from #921 (that clears it up for the 2.9 branch). A twine check is added for validating the release package *before* trying to upload it. The sphinx sections needed a fix for the rendering of the changelog. Specific rules for sections can be found in here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections #### QA Steps The following command will do the first part of the release process where we generate a package with `setup.py`, and then check that package with `twine check`. ``` $ rm -rf dist && python setup.py sdist && twine check dist/* && rm -rf dist ``` So this command should produce an output that says `PASSED`: ```sh .... .... .... copying juju/client/proxy/factory.py -> juju-3.2.2.0/juju/client/proxy copying juju/client/proxy/proxy.py -> juju-3.2.2.0/juju/client/proxy copying juju/client/proxy/kubernetes/proxy.py -> juju-3.2.2.0/juju/client/proxy/kubernetes Writing juju-3.2.2.0/setup.cfg creating dist Creating tar archive removing 'juju-3.2.2.0' (and everything under it) Checking dist/juju-3.2.2.0.tar.gz: PASSED ```
2 parents 24db195 + db58dca commit 54c49e2

5 files changed

Lines changed: 9 additions & 11 deletions

File tree

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ release:
3939
git fetch --tags
4040
rm dist/*.tar.gz || true
4141
$(PY) setup.py sdist
42-
$(BIN)/twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
42+
$(BIN)/twine check dist/*
43+
$(BIN)/twine upload --repository juju dist/*
4344
git tag ${VERSION}
4445
git push --tags
4546

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.2.2
1+
3.2.2.0

docs/changelog.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ Wednesday 6th September 2023
88

99
This is a minor release on the 3.x track, works with any Juju 3.x controller.
1010

11-
What's Changed
12-
==============
11+
## What's Changed
1312

1413
* Repository Maintenance Improvements by @cderici in https://github.com/juju/python-libjuju/pull/922
1514
* Stale bot to not bother feature requests by @cderici in https://github.com/juju/python-libjuju/pull/926
@@ -101,8 +100,7 @@ This version is only tested using Juju 3.1.0.
101100
* Add compatibility for juju 3.1.0 by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/799
102101
* Replace schemas.json with a wellformed version. by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/800
103102

104-
New Contributors
105-
================
103+
## New Contributors
106104

107105
* @mert-kirpici made their first contribution in https://github.com/juju/python-libjuju/pull/731
108106

@@ -117,8 +115,7 @@ Wednesday 26th October
117115
* [JUJU-2026] Improve resolve charm by @cderici in https://github.com/juju/python-libjuju/pull/761
118116
* Add owner and data to license file by @arturo-seijas in https://github.com/juju/python-libjuju/pull/760
119117

120-
New Contributors
121-
================
118+
## New Contributors
122119

123120
* @arturo-seijas made their first contribution in https://github.com/juju/python-libjuju/pull/760
124121

docs/readme.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ Here's a simple example that shows basic usage of the library. The example
4040
connects to the currently active Juju model, deploys a single unit of the
4141
ubuntu charm, then exits:
4242

43-
.. note::
44-
45-
Pylibjuju requires an already bootstrapped Juju controller to connect to.
43+
Note : Pylibjuju requires an already bootstrapped Juju controller to connect to.
4644

4745
.. code:: python
4846

setup.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
readme.read_text(),
1313
changelog.read_text()
1414
)
15+
long_description_content_type = 'text/x-rst'
1516
version = here / 'VERSION'
1617

1718
setup(
@@ -39,6 +40,7 @@
3940
maintainer_email='juju@lists.ubuntu.com',
4041
description=('Python library for Juju'),
4142
long_description=long_description,
43+
long_description_content_type=long_description_content_type,
4244
url='https://github.com/juju/python-libjuju',
4345
license='Apache 2',
4446
classifiers=[

0 commit comments

Comments
 (0)