-
Notifications
You must be signed in to change notification settings - Fork 59
Update releasing docs #684
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,3 @@ | ||
# Making a new release of jupytergis | ||
Please view our releasing guide on ReadTheDocs: | ||
|
||
The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser). | ||
|
||
## Manual release | ||
|
||
### Python package | ||
|
||
This extension can be distributed as Python | ||
packages. All of the Python | ||
packaging instructions in the `pyproject.toml` file to wrap your extension in a | ||
Python package. Before generating a package, we first need to install `build`. | ||
|
||
```bash | ||
pip install build twine | ||
``` | ||
|
||
To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do: | ||
|
||
```bash | ||
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: | ||
|
||
```bash | ||
twine upload dist/* | ||
``` | ||
|
||
### NPM package | ||
|
||
To publish the frontend part of the extension as a NPM package, do: | ||
|
||
```bash | ||
npm login | ||
npm publish --access public | ||
``` | ||
|
||
## Automated releases with the Jupyter Releaser | ||
|
||
The extension repository should already be compatible with the Jupyter Releaser. | ||
|
||
Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information. | ||
|
||
Here is a summary of the steps to cut a new release: | ||
|
||
- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser) | ||
- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork | ||
- Go to the Actions panel | ||
- Run the "Draft Changelog" workflow | ||
- Merge the Changelog PR | ||
- Run the "Draft Release" workflow | ||
- Run the "Publish Release" workflow | ||
|
||
## 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. | ||
<https://jupytergis.readthedocs.io/en/latest/contributor_guide/releasing.html> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do we feel about completely removing this file? 🤔