Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: automate releases, add check for py3.7, and create pr checklist #201

Merged
merged 40 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
37c49b3
add release github action workflow
aryarm Nov 22, 2023
8929a1b
ensure PR titles use conventional commits spec
aryarm Nov 22, 2023
1605bf1
update publishing instructions
aryarm Nov 22, 2023
cf1f7b7
also make sure to install build
aryarm Nov 23, 2023
b91f609
convert RELEASE_NOTES.rst to CHANGELOG.md
aryarm Nov 25, 2023
1fb9610
delete release notes from rtd
aryarm Nov 25, 2023
6f647b7
delete release_notes from TOC
aryarm Nov 25, 2023
0ed7cc0
move pytest and pylint config into pyproject
aryarm Nov 25, 2023
ec20a37
update to latest coverage
aryarm Nov 25, 2023
94b39a5
use stable instead of latest RTD
aryarm Nov 25, 2023
caff4b9
mention maintainer of repo in PUBLISHING doc
aryarm Dec 16, 2023
2b5295f
add min versions for all dependencies
aryarm Dec 16, 2023
d1b50ac
refer to maintainers in publishing docs
aryarm Dec 16, 2023
45d8c6b
Revert "add min versions for all dependencies"
aryarm Dec 19, 2023
a992074
add release github action workflow
aryarm Nov 22, 2023
6accd5e
ensure PR titles use conventional commits spec
aryarm Nov 22, 2023
e9527f3
update publishing instructions
aryarm Nov 22, 2023
6ce5147
also make sure to install build
aryarm Nov 23, 2023
18cbee8
convert RELEASE_NOTES.rst to CHANGELOG.md
aryarm Nov 25, 2023
d589b96
delete release notes from rtd
aryarm Nov 25, 2023
8e3937e
delete release_notes from TOC
aryarm Nov 25, 2023
db387a6
move pytest and pylint config into pyproject
aryarm Nov 25, 2023
1c5181b
update to latest coverage
aryarm Nov 25, 2023
a8883f1
use stable instead of latest RTD
aryarm Nov 25, 2023
ff9bec3
mention maintainer of repo in PUBLISHING doc
aryarm Dec 16, 2023
2941653
add min versions for all dependencies
aryarm Dec 16, 2023
c01e404
refer to maintainers in publishing docs
aryarm Dec 16, 2023
b1f4b2b
Revert "add min versions for all dependencies"
aryarm Dec 19, 2023
28c019a
Merge branch 'build/automated-releases' of https://github.com/gymrek-…
aryarm Dec 19, 2023
ac264bc
clean up after messy merge
aryarm Dec 19, 2023
f01f720
try to add py3.7 to ci
aryarm Dec 20, 2023
4a152e5
remove setuptools-scm from test action
aryarm Dec 20, 2023
f239897
Merge branch 'master' into build/automated-releases
aryarm Dec 21, 2023
5838f69
Delete RELEASE_NOTES.rst
aryarm Dec 22, 2023
b8a9843
try linking directly to changelog from toc
aryarm Jan 3, 2024
ec80d5d
fix link to changelog in toc
aryarm Jan 4, 2024
d2b88f5
Merge branch 'master' into build/automated-releases
aryarm Jan 4, 2024
7a33dee
format release notes toc text the way it was before
aryarm Jan 4, 2024
c921fe4
add pr checklist
aryarm Jan 7, 2024
7762d87
docs: reviewer and maintainer responsibilities with automated release…
aryarm Jan 7, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[run]
omit = *test*,setup.py
omit = *test*

[report]
exclude_lines =
Expand Down
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Checklist

* [ ] I've checked to ensure there aren't already other open [pull requests](../../../pulls) for the same update/change
* [ ] I've prefixed the title of my PR according to [the conventional commits specification](https://www.conventionalcommits.org/). If your PR fixes a bug, please prefix the PR with `fix: `. Otherwise, if it introduces a new feature, please prefix it with `feat: `. If it introduces a breaking change, please add an exclamation before the colon, like `feat!: `. If the scope of the PR changes because of a revision to it, please update the PR title, since the title will be used in our CHANGELOG.
* [ ] At the top of the PR, I've [listed any open issues that this PR will resolve](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). For example, "resolves #0" if this PR resolves issue #0
- [ ] I've explained my changes in a manner that will make it possible for both users and maintainers of TRTools to understand them
* [ ] I've added tests for any new functionality. Or, if this PR fixes a bug, I've added test(s) that replicate it
* [ ] I've updated the relevant REAMDEs with any new usage information and checked that the newly built documentation is formatted properly
* [ ] All functions, modules, classes etc. still conform to [numpy docstring standards](https://numpydoc.readthedocs.io/en/latest/format.html)
* [ ] (if applicable) I've updated the pyproject.toml file with any changes I've made to TRTools's dependencies
* [ ] In the body of this PR, I've included a short address to the reviewer highlighting one or two items that might deserve their focus
23 changes: 23 additions & 0 deletions .github/workflows/conventional-prs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Title
on:
pull_request_target:
types:
- opened
- reopened
- edited
- synchronize
workflow_call:

permissions:
contents: read

jobs:
title-format:
permissions:
pull-requests: read # for amannn/action-semantic-pull-request to analyze PRs
statuses: write # for amannn/action-semantic-pull-request to mark status of analyzed PR
runs-on: ubuntu-latest
steps:
- uses: amannn/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47 changes: 47 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Release

on:
push:
branches:
- master

jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- uses: GoogleCloudPlatform/release-please-action@v3
id: release
with:
release-type: python
package-name: trtools

- uses: actions/checkout@v3
if: ${{ steps.release.outputs.release_created }}
with:
fetch-depth: 2

- name: Set up Python
if: ${{ steps.release.outputs.release_created }}
uses: actions/setup-python@v4
with:
python-version: '3.8'

- name: Upgrade pip
if: ${{ steps.release.outputs.release_created }}
run: |
pip install --upgrade pip
pip install build
pip --version

- name: Build package
if: ${{ steps.release.outputs.release_created }}
run: |
python -m build

- name: Publish package on PyPI
if: ${{ steps.release.outputs.release_created }}
uses: pypa/[email protected]
with:
user: __token__
password: ${{ secrets.PYPI_TOKEN }}
6 changes: 3 additions & 3 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]

steps:
- uses: actions/checkout@v4
Expand All @@ -33,12 +33,12 @@ jobs:
- name: Upgrade pip and install our package
shell: bash -el {0}
run: |
python -m pip install --upgrade pip setuptools wheel setuptools-scm
python -m pip install --upgrade pip setuptools wheel
pip install -e .
- name: Test with pytest
shell: bash -el {0}
run: |
python -m pytest --cov=. --cov-report term-missing --cov-fail-under 89 --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml
python -m pytest --cov=. --cov-report term-missing --cov-fail-under 90 --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml
- name: Test command line
shell: bash -el {0}
run: |
Expand Down
10 changes: 0 additions & 10 deletions .pylintrc

This file was deleted.

Loading
Loading