This repository was archived by the owner on May 20, 2020. It is now read-only.
File tree Expand file tree Collapse file tree 4 files changed +78
-2
lines changed Expand file tree Collapse file tree 4 files changed +78
-2
lines changed Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change @@ -13,8 +13,17 @@ A JupyterLab extension for rendering Plotly Dash apps as a separate window in Ju
13
13
- JupyterLab
14
14
15
15
## Installation
16
+ The jupyterlab-dash library requires both a Python package and a JupyterLab
17
+ extension.
16
18
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
18
27
19
28
``` bash
20
29
git clone https://github.com/plotly/jupyterlab-dash
Original file line number Diff line number Diff line change
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"
Original file line number Diff line number Diff line change @@ -72,7 +72,7 @@ def run(self):
72
72
sys .executable ))
73
73
74
74
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/*' )
76
76
77
77
self .status ('Pushing git tags…' )
78
78
os .system ('git tag v{0}' .format (about ['__version__' ]))
You can’t perform that action at this time.
0 commit comments