Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup release process #921

Merged
merged 4 commits into from Jul 21, 2023
Merged

Cleanup release process #921

merged 4 commits into from Jul 21, 2023

Conversation

cderici
Copy link
Member

@cderici cderici commented Jul 20, 2023

Description

This fixes up some of the bumps in the release process (make release).

  • Twine complains about the long_description content type not being set, so this adds long_description_content_type in the setup.py
  • There's a section named note:: in the readme, apparently that's not a thing in the earlier versions of sphinx, so this removes it.
  • twine uses the username/password when it's called with --repository-url https://upload.pypi.org/legacy/ parameter, which is not anymore a thing (at least for our project), so we're using .pypirc with tokens (as described in the release document for pylibjuju), so this changes twine call to use --repository juju, which is simply a reference to the entry in the .pypirc.

QA Steps

No QA needed.

Notes & Discussion

When forward ported, the docs/changelog.rst in the master branch needs to be fixed (for sections/subsections). Just call and you'll see the error:

.tox/py3/bin/python3 setup.py sdist && twine check dist/*

@cderici cderici added 2.9 forward port please remove label after ported maintenance labels Jul 20, 2023
@cderici cderici requested a review from jack-w-shaw July 20, 2023 22:33
setup.py Show resolved Hide resolved
@cderici
Copy link
Member Author

cderici commented Jul 21, 2023

/merge

@jujubot jujubot merged commit 6b73402 into juju:2.9 Jul 21, 2023
5 of 6 checks passed
@cderici cderici mentioned this pull request Sep 5, 2023
jujubot added a commit that referenced this pull request Sep 6, 2023
#944

## What's Changed

This is a patch release on the `2.9` track. Most significant change is the added support for nested `assumes` expressions in #940.

* Cleanup release process by @cderici in #921
* [JUJU-4488] Add licence headers to source files by @cderici in #933
* Parse nested assumes expressions by @cderici in #940

[JUJU-4488]: https://warthogs.atlassian.net/browse/JUJU-4488?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
jujubot added a commit that referenced this pull request Sep 19, 2023
#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
```
@cderici cderici removed the forward port please remove label after ported label Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants