Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 2.33 KB

RELEASE.md

File metadata and controls

80 lines (53 loc) · 2.33 KB
Raw

Making a new release of ipylgbst

The extension can be published to PyPI and npm manually or using the Jupyter Releaser.

Manual release

Python package

This extension can be distributed as Python packages. All of the Python packaging instructions are in the pyproject.toml file to wrap your extension in a Python package. Before generating a package, you first need to install some tools:

pip install build twine hatch

Bump the version using hatch. By default this will create a tag. See the docs on hatch-nodejs-version for details.

hatch version <new-version>

Make sure to clean up all the development files before building the package:

jlpm clean:all

You could also clean up the local git repository:

git clean -dfX

To create a Python source package (.tar.gz) and the binary package (.whl) in the dist/ directory, do:

python -m build

python setup.py sdist bdist_wheel is deprecated and will not work for this package.

Then to upload the package to PyPI, do:

twine upload dist/*

NPM package

To publish the frontend part of the extension as a NPM package, do:

npm login
npm publish --access public

Automated releases with the Jupyter Releaser

The extension repository should already be compatible with the Jupyter Releaser. But the GitHub repository and the package managers need to be properly set up. Please follow the instructions of the Jupyter Releaser checklist.

Here is a summary of the steps to cut a new release:

  • Go to the Actions panel
  • Run the "Step 1: Prep Release" workflow
  • Check the draft changelog
  • Run the "Step 2: Publish Release" workflow

Note

Check out the workflow documentation for more information.

Publishing to conda-forge

If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html

Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.