Skip to content

Commit 313a22d

Browse files
moomoohkmoomoohk
committed
Merge branch 'master' into version/2.x
2 parents 9f7c354 + 9f1d57e commit 313a22d

8 files changed

Lines changed: 132 additions & 36 deletions

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: Deploy to PyPI
4+
5+
# Controls when the workflow will run
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the master branch
8+
release:
9+
types: [published]
10+
11+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
12+
jobs:
13+
# This workflow contains a single job called "build"
14+
deploy:
15+
# The type of runner that the job will run on
16+
runs-on: ubuntu-latest
17+
18+
# Steps represent a sequence of tasks that will be executed as part of the job
19+
steps:
20+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
21+
- uses: actions/checkout@v2
22+
23+
- name: PyPI Deployment
24+
# You may pin to the exact commit or the version.
25+
# uses: casperdcl/deploy-pypi@bb869aafd89f657ceaafe9561d3b5584766c0f95
26+
uses: casperdcl/deploy-pypi@v2
27+
with:
28+
# PyPI username
29+
user: ${{ secrets.PYPI_USER }}
30+
# PyPI password or API token
31+
password: ${{ secrets.TEST_PYPI_PASS }}
32+
# Build requirements
33+
# requirements: # optional, default is twine wheel
34+
# `setup.py` command to run ("true" is a shortcut for "clean sdist -d <dist_dir> bdist_wheel -d <dist_dir>")
35+
build: clean sdist -d dist/
36+
# `pip` command to run ("true" is a shortcut for "wheel -w <dist_dir> --no-deps .")
37+
pip: true

‎.github/workflows/tests.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: Run tests
4+
5+
# Controls when the workflow will run
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the master branch
8+
push:
9+
pull_request:
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
15+
jobs:
16+
# This workflow contains a single job called "tests"
17+
tests:
18+
# The type of runner that the job will run on
19+
runs-on: ubuntu-latest
20+
21+
strategy:
22+
matrix:
23+
# Match versions specified in tox.ini
24+
python-version: [3.6, 3.8, 3.9, pypy-3.7]
25+
26+
# Steps represent a sequence of tasks that will be executed as part of the job
27+
steps:
28+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
29+
- name: Check out code
30+
uses: actions/checkout@v2
31+
32+
- name: Set up Python ${{ matrix.python-version }}
33+
uses: actions/setup-python@main
34+
with:
35+
python-version: ${{ matrix.python-version }}
36+
37+
# Instead of installing and running tox and tox-gh-actions,
38+
# you can simply use this composite run steps action.
39+
- name: Run tox with tox-gh-actions
40+
uses: ymyzk/run-tox-gh-actions@main
41+
with:
42+
tox-args: -vv

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
.vscode
88
venv_39
99
.idea/
10-
dpath.egg-info/
10+
dpath.egg-info/
11+
dist/

‎.travis.yml‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎MAINTAINERS.md‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,22 @@
11
Who Maintains DPATH
22
===================
33

4-
dpath is primarily maintained by Andrew Kesterson <andrew@aklabs.net> and Caleb Case <calebcase@gmail.com>. These two individuals collectively govern the project.
4+
dpath was created by and originally maintained by Andrew Kesterson <andrew@aklabs.net> and Caleb Case <calebcase@gmail.com>. In July
5+
of 2020 they put out a call for new maintainers. [@bigsablept](https://github.com/bigsablept) and
6+
[@moomoohk](https://github.com/moomoohk) stepped up to become the new maintainers.
57

68
There are several individuals in the community who have taken an active role in helping to maintain the project and submit fixes. Those individuals are shown in the git changelog.
79

8-
Becoming a Maintainer
9-
=====================
10-
11-
Nobody has to become a maintainer to submit a patch against dpath. Simply send the pull request on github.
12-
13-
If you would like to help triage issues, attend monthly meetings, and become a regular part of the team working on the roadmap, send an email to andrew@aklabs.net and/or calebcase@gmail.com.
14-
1510
Where and How do we communicate
1611
===============================
1712

1813
The dpath maintainers communcate in 3 primary ways:
1914

2015
1. Email, directly to each other.
2116
2. Github via issue and pull request comments
22-
3. A monthly maintainers meeting via telephone
17+
3. A monthly maintainers meeting via Zoom
18+
19+
The remainder of this document is subject to change after further discussion among the new maintainers.
2320

2421
What is the roadmap
2522
===================
@@ -76,11 +73,21 @@ The more complete process goes:
7673
6. Send your pull request
7774
7. If accepted, the maintainers will merge your pull request and close the issue.
7875

76+
Branching Strategy
77+
==================
78+
79+
We run a clean bleeding edge master. Long term support for major version numbers are broken out into version branches.
80+
81+
* master : Current 3.x (bleeding edge) development
82+
* version/1.x : 1.x series bugfixes
83+
* version/2.x : 2.x series features and bugfixes
84+
85+
We name bugfixes as "bugfix/ISSUENUMBER_shortname"; features are named "feature/ISSUENUMBER_shortname". All branches representing work against an issue must have the issue number in the branch name.
7986

8087
Cutting a New Release
8188
=====================
8289

83-
Releases for dpath occur automatically from travis-ci based on tags on the master branch.
90+
Releases for dpath occur automatically from travis-ci based on tags on the master branch, or on the version/[0-9].x branches for major version LTS.
8491

8592
akesterson@akesterson:~/dpath-python$ git tag
8693
1.0-0
@@ -108,11 +115,11 @@ Once upon a time, the version string was automatially computed based on the cont
108115

109116
To cut a new release, follow this procedure:
110117

111-
1. Commit a new dpath/version.py on the master branch with the format "MAJOR.MINOR.RELEASE"
112-
2. Add a new tag of the form "build,MAJOR.MINOR,RELEASE" to the master branch. This tag must have the same version number as the one commmited in dpath/version.py or we will fill your desk drawers with cockroaches.
113-
3. Push the new master version and the associated tag to github.
118+
1. Commit a new dpath/version.py on the appropriate branch with the format "MAJOR.MINOR.RELEASE"
119+
2. Add a new tag of the form "build,MAJOR.MINOR,RELEASE" to the appropriate branch. This tag must have the same version number as the one commmited in dpath/version.py or we will fill your desk drawers with cockroaches.
120+
3. Push the new branch version and the associated tag to github.
114121
4. travis-ci SHOULD push the new release to pypi.
115122

116123
If travis-ci fails to update pypi, follow the instructions on manually creating a release, here:
117124

118-
https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives
125+
https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives

‎README.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,10 @@ value 'Waffles'.
157157
{
158158
"a": {
159159
"b": {
160-
"3": 2,
161-
"43": 30,
162-
"c": "Waffles",
163-
"d": "Waffles"
160+
"3": 2,
161+
"43": 30,
162+
"c": "Waffles",
163+
"d": "Waffles"
164164
}
165165
}
166166
}

‎maintainers_log.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# 03/29/2020
2+
3+
Attendees : Caleb, Andrew
4+
5+
## Old business :
6+
7+
* Need to onboard new member Vladimir Ulogov <vladimir.ulogov@me.com>
8+
* No movement
9+
* Need to make project board for 1.5 open bugs
10+
* Done
11+
12+
## New business :
13+
14+
* Andrew to define maintainers meeting process and establish log of decisions, process for filing open action items
15+
* Andrew to forward maintainers invite to Vladimir and include in next monthly maintainers meeting
16+
* Andrew to set followup for 1wk from now to check for comments on PRs and cut release version for 1.x / 2.x
17+
* Andrew to rename LTS branches from version/1.0 version/2.0 to version/1.x and version/2.x

‎tox.ini‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@
77
ignore = E501,E722
88

99
[tox]
10-
envlist = flake8, py36, py38, pypy3
10+
envlist = py36, pypy37, py38, py39, flake8
11+
12+
[gh-actions]
13+
python =
14+
3.6: py36
15+
# TODO(moomoohk): Get pypy to work properly. https://github.com/ymyzk/run-tox-gh-actions/issues/3
16+
pypi-3.7: pypy37
17+
3.8: py38
18+
3.9: py39, flake8
1119

1220
[testenv]
1321
deps =

0 commit comments

Comments
 (0)