Skip to content

Commit ca367fb

Browse files
committed
Add pull request template and update release process workflow
1 parent 330b8fc commit ca367fb

File tree

3 files changed

+32
-48
lines changed

3 files changed

+32
-48
lines changed

.github/pull_request_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Title: Summary, imperative, start upper case, don't end with a period
2+
<!-- Ideally, <=50 chars. 50 chars is here..: -->
3+
4+
### Description
5+
<!-- For use in commit message, wrap at 72 chars. 72 chars is here: -->
6+
- *Category*: <!-- one of bugfix, feature, refactor, POC, CI/infrastructure, documentation,
7+
revert, test, release, other/misc -->
8+
- *JIRA issue*: <!-- [MIC-XYZ](https://jira.ihme.washington.edu/browse/MIC-XYZ) -->
9+
10+
<!--
11+
Change description – why, what, anything unexplained by the above.
12+
Include guidance to reviewers if changes are complex.
13+
-->
14+
15+
### Testing
16+
<!--
17+
Details on how code was verified, any unit tests local for the
18+
repo, regression testing, etc. At a minimum, this should include an
19+
integration test for a framework change. Consider: plots, images,
20+
(small) csv file.
21+
-->
22+

.github/workflows/build.yml

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,10 @@
1+
# -----------------------------------------------------------------------------
2+
# - invoked on push, pull_request, or manual trigger
3+
# - test under 3 versions of python
4+
# - look for an upstream (vivarium) branch and use it if it exists
5+
# -----------------------------------------------------------------------------
16
name: build
2-
3-
on:
4-
push:
5-
branches:
6-
- '*'
7-
tags-ignore:
8-
- v*
9-
pull_request:
10-
branches:
11-
- '*'
12-
tags-ignore:
13-
- v*
14-
# Run this workflow manually from the Actions tab.
15-
workflow_dispatch:
7+
on: [push, pull_request, workflow_dispatch]
168

179
jobs:
1810
build:

.github/workflows/deploy.yml

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,18 @@
11
name: deploy
22

33
on:
4-
push:
5-
tags:
6-
- v*
4+
release:
5+
types: [published]
76

87
jobs:
9-
build:
10-
runs-on: ubuntu-latest
11-
strategy:
12-
matrix:
13-
python-version: [3.6, 3.7, 3.8]
14-
steps:
15-
- uses: actions/checkout@v2
16-
- name: Set up Python ${{ matrix.python-version }}
17-
uses: actions/setup-python@v2
18-
with:
19-
python-version: ${{ matrix.python-version }}
20-
- name: Print environment values
21-
run: |
22-
cat $GITHUB_ENV
23-
- name: Update pip
24-
run: |
25-
python -m pip install --upgrade pip
26-
- name: Install dependencies
27-
run: |
28-
pip install .[dev]
29-
- name: Test
30-
run: |
31-
pytest ./tests
32-
- name: Doc build
33-
run: |
34-
make html -C docs/ SPHINXOPTS="-W --keep-going -n"
35-
- name: Doctest
36-
run: |
37-
make doctest -C docs/
388
deploy:
399
runs-on: ubuntu-latest
4010
steps:
4111
- uses: actions/checkout@v2
4212
- name: Set up Python
4313
uses: actions/setup-python@v2
4414
with:
45-
python-version: '3.8.x'
15+
python-version: '3.8'
4616
- name: Install dependencies
4717
run: |
4818
python -m pip install --upgrade pip
@@ -53,4 +23,4 @@ jobs:
5323
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
5424
run: |
5525
python setup.py sdist bdist_wheel
56-
twine upload dist/*
26+
twine upload dist/*

0 commit comments

Comments
 (0)