Skip to content

Commit

Permalink
Merge pull request #946 from cderici/cleanup-release-process-3.x
Browse files Browse the repository at this point in the history
#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
```
  • Loading branch information
jujubot authored Sep 19, 2023
2 parents 24db195 + db58dca commit 54c49e2
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 11 deletions.
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ release:
git fetch --tags
rm dist/*.tar.gz || true
$(PY) setup.py sdist
$(BIN)/twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
$(BIN)/twine check dist/*
$(BIN)/twine upload --repository juju dist/*
git tag ${VERSION}
git push --tags

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.2.2
3.2.2.0
9 changes: 3 additions & 6 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ Wednesday 6th September 2023

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

What's Changed
==============
## What's Changed

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

New Contributors
================
## New Contributors

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

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

New Contributors
================
## New Contributors

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

Expand Down
4 changes: 1 addition & 3 deletions docs/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ Here's a simple example that shows basic usage of the library. The example
connects to the currently active Juju model, deploys a single unit of the
ubuntu charm, then exits:

.. note::

Pylibjuju requires an already bootstrapped Juju controller to connect to.
Note : Pylibjuju requires an already bootstrapped Juju controller to connect to.

.. code:: python
Expand Down
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
readme.read_text(),
changelog.read_text()
)
long_description_content_type = 'text/x-rst'
version = here / 'VERSION'

setup(
Expand Down Expand Up @@ -39,6 +40,7 @@
maintainer_email='[email protected]',
description=('Python library for Juju'),
long_description=long_description,
long_description_content_type=long_description_content_type,
url='https://github.com/juju/python-libjuju',
license='Apache 2',
classifiers=[
Expand Down

0 comments on commit 54c49e2

Please sign in to comment.