Skip to content
This repository was archived by the owner on May 20, 2020. It is now read-only.

Commit 6d68673

Browse files
committed
Pre-release CHANGELOG, README updates and RELEASE instructions
1 parent 7c7b1e4 commit 6d68673

File tree

4 files changed

+78
-2
lines changed

4 files changed

+78
-2
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
All notable changes to this project will be documented in this file.
3+
This project strives to adheres to [Semantic Versioning](http://semver.org/).
4+
5+
6+
## [0.1.0a1] - 2019-03-24
7+
Initial release

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,17 @@ A JupyterLab extension for rendering Plotly Dash apps as a separate window in Ju
1313
- JupyterLab
1414

1515
## Installation
16+
The jupyterlab-dash library requires both a Python package and a JupyterLab
17+
extension.
1618

17-
We haven't published the component yet, but we will soon. In the meantime, you'll need to clone the repo and install manually:
19+
```
20+
$ pip install jupyterlab-dash==0.1.0a1
21+
$ jupyter labextension install [email protected]
22+
```
23+
24+
## Development Installation
25+
26+
If you'd like to install jupyterlab-dash for development
1827

1928
```bash
2029
git clone https://github.com/plotly/jupyterlab-dash

RELEASE.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## Check out the most recent version of master
2+
```
3+
$ git checkout master
4+
$ git stash
5+
$ git pull
6+
```
7+
8+
## Update CHANGELOG and README
9+
Update the `CHANGELOG.md` file with changes since the last release.
10+
11+
Update the README with the new version numbers, and push README updates.
12+
13+
Commit and push these updates.
14+
15+
## Release jupyterlab-dash to PyPI
16+
Install `twine`
17+
18+
```
19+
$ pip install twine
20+
```
21+
22+
Update version in `jupyterlab_dash/__version__.py`.
23+
This will be referred to as version `A.B.C` below.
24+
25+
Build and upload
26+
```
27+
$ python setup.py upload
28+
```
29+
30+
## Release jupyterlab-dash to NPM
31+
First [install yarn](https://yarnpkg.com/lang/en/docs/install/).
32+
33+
To publish a pre-release
34+
```
35+
yarn publish --access public --tag next
36+
```
37+
38+
To publish a final release
39+
```
40+
yarn publish --access public
41+
```
42+
43+
Enter the new version number in the prompt
44+
45+
Then tag the release (Where `X.Y.Z` is the version entered above)
46+
47+
```
48+
$ git tag jupyterlab-vX.Y.Z
49+
$ git push origin jupyterlab-vX.Y.Z
50+
```
51+
52+
## Add GitHub Release entry
53+
54+
Go to https://github.com/plotly/jupyterlab-dash/releases and "Draft a new release"
55+
56+
Enter the `vA.B.C` tag
57+
58+
Make "Release title" the same string as the tag.
59+
60+
Copy changelog section for this version as the "Describe this release"

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def run(self):
7272
sys.executable))
7373

7474
self.status('Uploading the package to PyPI via Twine…')
75-
os.system('twine upload --repository-url https://test.pypi.org/legacy/ dist/*')
75+
os.system('twine upload dist/*')
7676

7777
self.status('Pushing git tags…')
7878
os.system('git tag v{0}'.format(about['__version__']))

0 commit comments

Comments
 (0)