Skip to content

Commit f554df1

Browse files
release preparation (#134)
* added release.yml to automate release to pypi process, fixed long_description type (was causing error) * added release notes from pymc repo
1 parent 831a894 commit f554df1

File tree

3 files changed

+73
-1
lines changed

3 files changed

+73
-1
lines changed

.github/release.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# This file contains configuration for the automatic generation of release notes in GitHub.
2+
# It's not perfect, but it makes it a little less laborious to write informative release notes.
3+
# Also see https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
4+
changelog:
5+
exclude:
6+
labels:
7+
- no releasenotes
8+
categories:
9+
- title: Major Changes 🛠
10+
labels:
11+
- major
12+
- title: New Features 🎉
13+
labels:
14+
- enhancements
15+
- feature request
16+
- title: Bugfixes 🪲
17+
labels:
18+
- bug
19+
- title: Documentation 📖
20+
labels:
21+
- docs
22+
- title: Maintenance 🔧
23+
labels:
24+
- "*"

.github/workflows/release.yml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: release-pipeline
2+
3+
on:
4+
release:
5+
types:
6+
- created
7+
8+
jobs:
9+
release-job:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- name: Set up Python
14+
uses: actions/setup-python@v4
15+
with:
16+
python-version: 3.7
17+
- name: Install release tools
18+
run: |
19+
python -m pip install --upgrade pip
20+
pip install setuptools wheel twine
21+
- name: Build distribution package
22+
run: python setup.py sdist bdist_wheel
23+
- name: Check version number match
24+
run: |
25+
echo "GITHUB_REF: ${GITHUB_REF}"
26+
# The GITHUB_REF should be something like "refs/tags/v1.2.3"
27+
# Make sure the package version is the same as the tag
28+
grep -Rq "^Version: ${GITHUB_REF:11}$" pymc.egg-info/PKG-INFO
29+
- name: Publish to PyPI
30+
env:
31+
TWINE_USERNAME: __token__
32+
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN_PYMC }}
33+
run: |
34+
twine check dist/*
35+
twine upload --repository pypi --username __token__ --password ${PYPI_TOKEN} dist/*
36+
test-install-job:
37+
needs: release-job
38+
runs-on: ubuntu-latest
39+
steps:
40+
- name: Set up Python
41+
uses: actions/setup-python@v4
42+
with:
43+
python-version: 3.7
44+
- name: Give PyPI a chance to update the index
45+
run: sleep 240
46+
- name: Install from PyPI
47+
run: |
48+
pip install pymc-experimental==${GITHUB_REF:11}

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def get_version():
8585
license=LICENSE,
8686
url=URL,
8787
long_description=LONG_DESCRIPTION,
88-
long_description_content_type="text/x-rst",
88+
long_description_content_type="text/markdown",
8989
packages=find_packages(),
9090
# because of an upload-size limit by PyPI, we're temporarily removing docs from the tarball.
9191
# Also see MANIFEST.in

0 commit comments

Comments
 (0)