Skip to content

Commit

Permalink
Prep for Release Helper Usage
Browse files Browse the repository at this point in the history
  • Loading branch information
jtpio committed Apr 25, 2021
1 parent ca5622a commit 70819e9
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 21 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/check-release.yml
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 }}
10 changes: 0 additions & 10 deletions .github/workflows/python-linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,3 @@ jobs:
pushd test_install
./bin/pytest --pyargs jupyter_server
popd
- name: Check the Manifest
run: |
pip install check-manifest
git clean -dfx
check-manifest -v
- name: Check Version Bump
run: |
pip install tbump
tbump --non-interactive --only-patch 100.1.1
git checkout .
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

All notable changes to this project will be documented in this file.

<!-- <START NEW CHANGELOG ENTRY> -->

## 1.6.4

([Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/v1.6.3...68a64ea13be5d0d86460f04e0c47eb0b6662a0af))
Expand All @@ -16,6 +18,8 @@ All notable changes to this project will be documented in this file.

[@afshin](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Aafshin+updated%3A2021-04-21..2021-04-21&type=Issues)

<!-- <END NEW CHANGELOG ENTRY> -->

## 1.6.3

([Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/v1.6.2...aa2636795ae1d87e3055febb3931f891dd6b4451))
Expand Down
34 changes: 23 additions & 11 deletions RELEASE.md
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/*
```

0 comments on commit 70819e9

Please sign in to comment.