Skip to content

Commit 4b13c1d

Browse files
authored
Use Jupyter Releaser (#183)
1 parent cded276 commit 4b13c1d

File tree

3 files changed

+53
-27
lines changed

3 files changed

+53
-27
lines changed

.github/workflows/tests.yml

Lines changed: 39 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,9 @@ jobs:
5959
# See `setup.cfg` for full test options
6060
run: |
6161
pytest --pyargs jupyterlab_server
62-
- name: Check manifest
63-
run: |
64-
set -eux
65-
pip install check-manifest
66-
git clean -dfx
67-
check-manifest -v
6862
- name: Upload coverage
6963
run: |
7064
codecov
71-
- name: Install and Test SDist
72-
if: ${{ runner.os != 'Windows' }}
73-
run: |
74-
set -eux
75-
pip uninstall -y jupyterlab_server
76-
pip install build
77-
python -m build --sdist .
78-
cd dist
79-
pip install *.tar.gz
80-
pytest --pyargs jupyterlab_server
8165
- name: Build docs
8266
run: |
8367
set -eux
@@ -88,9 +72,43 @@ jobs:
8872
make html
8973
conda deactivate
9074
popd
91-
- name: Check Version Bump
75+
76+
check_release:
77+
runs-on: ubuntu-latest
78+
steps:
79+
- name: Checkout
80+
uses: actions/checkout@v2
81+
- name: Install Python
82+
uses: actions/setup-python@v2
83+
with:
84+
python-version: 3.9
85+
architecture: "x64"
86+
- name: Get pip cache dir
87+
id: pip-cache
9288
run: |
93-
set -eux
94-
pip install tbump
95-
tbump --non-interactive --only-patch 100.1.1
96-
git checkout .
89+
echo "::set-output name=dir::$(pip cache dir)"
90+
- name: Cache pip
91+
uses: actions/cache@v2
92+
with:
93+
path: ${{ steps.pip-cache.outputs.dir }}
94+
key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
95+
restore-keys: |
96+
${{ runner.os }}-pip-
97+
${{ runner.os }}-pip-
98+
- name: Cache checked links
99+
uses: actions/cache@v2
100+
with:
101+
path: ~/.cache/pytest-link-check
102+
key: ${{ runner.os }}-linkcheck-${{ hashFiles('**/.md') }}-md-links
103+
restore-keys: |
104+
${{ runner.os }}-linkcheck-
105+
- name: Upgrade packaging dependencies
106+
run: |
107+
pip install --upgrade pip setuptools wheel --user
108+
- name: Install Dependencies
109+
run: |
110+
pip install -e .
111+
- name: Check Release
112+
uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
113+
with:
114+
token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@ github_url: 'https://github.com/jupyterlab/jupyterlab_server/blob/master/CHANGEL
44

55
# Change Log
66

7+
<!-- <START NEW CHANGELOG ENTRY> -->
8+
79
## 2.5.1
810

911
### Maintenance and upkeep improvements
1012

1113
- Remove Packaging Dependency [#181](https://github.com/jupyterlab/jupyterlab_server/pull/181) ([@jtpio](https://github.com/jtpio))
1214

13-
## 2.5.0
15+
<!-- <END NEW CHANGELOG ENTRY> -->
1416

17+
## 2.5.0
1518

1619
([Full Changelog](https://github.com/jupyterlab/jupyterlab_server/compare/2.4.0...f5009812e86ec47e36b3d90569d1eaa4771c9939))
1720

RELEASE.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,32 @@
11
# Making a JupyterLab Server Release
2-
To create a release, perform the following steps...
32

4-
## Set up
3+
## Using `jupyter_releaser`
4+
5+
The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser#checklist-for-adoption).
6+
7+
## Manual Release
8+
9+
### Set up
510
```
611
pip install tbump twine build
712
git pull origin $(git branch --show-current)
813
git clean -dffx
914
```
1015

11-
## Update the version and apply the tag
16+
### Update the version and apply the tag
1217
```
1318
echo "Enter new version"
1419
read script_version
1520
tbump ${script_version}
1621
```
1722

18-
## Build the artifacts
23+
### Build the artifacts
1924
```
2025
rm -rf dist
2126
python -m build .
2227
```
2328

24-
## Publish the artifacts to pypi
29+
### Publish the artifacts to pypi
2530
```
2631
twine check dist/*
2732
twine upload dist/*

0 commit comments

Comments
 (0)