-
Notifications
You must be signed in to change notification settings - Fork 315
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
78 additions
and
21 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: Check Release | ||
on: | ||
push: | ||
branches: ["*"] | ||
|
||
permissions: | ||
contents: | ||
write | ||
|
||
jobs: | ||
check_release: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v1 | ||
- name: Install Python | ||
uses: actions/setup-python@v1 | ||
with: | ||
python-version: 3.9 | ||
architecture: "x64" | ||
- name: Get pip cache dir | ||
id: pip-cache | ||
run: | | ||
echo "::set-output name=dir::$(pip cache dir)" | ||
- name: Cache pip | ||
uses: actions/cache@v1 | ||
with: | ||
path: ${{ steps.pip-cache.outputs.dir }} | ||
key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }} | ||
restore-keys: | | ||
${{ runner.os }}-pip- | ||
${{ runner.os }}-pip- | ||
- name: Cache checked links | ||
uses: actions/cache@v2 | ||
with: | ||
path: ~/.cache/pytest-link-check | ||
key: ${{ runner.os }}-linkcheck-${{ hashFiles('**/.md') }}-md-links | ||
restore-keys: | | ||
${{ runner.os }}-linkcheck- | ||
- name: Upgrade packaging dependencies | ||
run: | | ||
pip install --upgrade pip setuptools wheel --user | ||
- name: Install Dependencies | ||
run: | | ||
pip install -e . | ||
- name: Check Release | ||
env: | ||
TWINE_PASSWORD: ${{ secrets.TEST_PYPI_TOKEN }} | ||
uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} |
This file contains 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
This file contains 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
This file contains 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,36 +1,48 @@ | ||
# Making a Jupyter Server Release | ||
To create a release, perform the following steps... | ||
|
||
## Set up | ||
``` | ||
## Using `jupyter_releaser` | ||
|
||
The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser#checklist-for-adoption). | ||
|
||
## Manual Release | ||
|
||
To create a manual release, perform the following steps: | ||
|
||
### Set up | ||
|
||
```bash | ||
pip install tbump twine build | ||
git pull origin $(git branch --show-current) | ||
git clean -dffx | ||
``` | ||
|
||
## Update the version and apply the tag | ||
``` | ||
### Update the version and apply the tag | ||
|
||
```bash | ||
echo "Enter new version" | ||
read script_version | ||
tbump ${script_version} | ||
``` | ||
|
||
## Build the artifacts | ||
``` | ||
### Build the artifacts | ||
|
||
```bash | ||
rm -rf dist | ||
python -m build . | ||
``` | ||
|
||
## Update the version back to dev | ||
``` | ||
### Update the version back to dev | ||
|
||
```bash | ||
echo "Enter dev version" | ||
read dev_version | ||
tbump ${dev_version} --no-tag | ||
git push origin $(git branch --show-current) | ||
``` | ||
|
||
## Publish the artifacts to pypi | ||
``` | ||
### Publish the artifacts to pypi | ||
|
||
```bash | ||
twine check dist/* | ||
twine upload dist/* | ||
``` |