gitlogstats 1.1.0__tar.gz → 1.3.0__tar.gz

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/.claude/CLAUDE.md

@@ -70,7 +70,8 @@ Changes are tracked on the GitHub project board (https://github.com/users/bloomb
 - **Do not commit code changes directly to the default branch (`master`).** Create a feature branch named `feat/<REQ-ID>-<slug>` (e.g. `feat/STAT-6-mailmap`; use a short descriptive slug when no requirement id applies). **Exception:** documentation (Markdown and anything under `docs/`) and project tooling under `scripts/` and `.claude/` may be committed directly to the default branch without a PR.
 - **Open a pull request** whose description includes `Closes #N` — `N` is the board issue's number — so the issue closes on merge. Commit and push only when asked, and run the checks above first.
 - **Do not hand-create board issues.** The board is generated from the SPEC: `npm run board:derive` regenerates `scripts/board/manifest.yaml`, then `npm run board:sync` creates or updates the issues (`-- --dry-run` previews; `-- --reconcile` forces SPEC statuses back onto the board). A requirement marked `Done` in the SPEC is always closed and moved to Done; other status moves are left to the board unless `--reconcile` is passed.
-- Pushing to `master` publishes a release to PyPI (see `.github/workflows/build.yaml`), so bump `version` in `pyproject.toml` when a change to the package should be released.
+- **Claude runs both board commands itself** (they are pre-approved in `.claude/settings.json`): `board:derive` whenever `docs/SPEC.md` changes, committing the manifest with the change; `board:sync` **before** opening a PR when the SPEC adds requirements (so `Closes #N` has an issue to point at), and again **after** the PR merges. Sync reads the working tree, so before the merge run it from a tree where the new requirements are still `Todo`/`In Progress` — syncing a branch that already marks them `Done` closes their issues before the code lands.
+- Merging a pull request into `master` publishes a release to PyPI once the tests pass on the merged code (see `.github/workflows/build.yaml`); pushes to other branches, and direct pushes to `master`, publish nothing. Bump `version` in `pyproject.toml` in the PR when a change to the package should be released; a merge without a bump skips the upload.
 
 If asked to use a different workflow (e.g. commit code straight to the default branch), **remind the user that it diverges from this flow and confirm before proceeding** — then honor the confirmed request.
 

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/.claude/settings.json

@@ -1,4 +1,7 @@
 {
+  "permissions": {
+    "allow": ["Bash(npm run board:derive*)", "Bash(npm run board:sync*)"]
+  },
   "hooks": {
     "PreToolUse": [
       {

gitlogstats-1.3.0/.github/workflows/build.yaml

@@ -0,0 +1,65 @@
+name: CI / CD
+# CI runs on every pull request into master and on every push to master.
+# Delivery to PyPI happens only when a pull request is merged into master,
+# and only if the tests pass on the merged code (PKG-2, PKG-4).
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+    types: [opened, synchronize, reopened, closed]
+permissions:
+  contents: read
+jobs:
+  build:
+    # a pull request closed without merging needs no checks
+    if: github.event.action != 'closed' || github.event.pull_request.merged
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.11']
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # after a merge, test the merge commit that landed on master
+          ref: ${{ github.event.pull_request.merged && github.event.pull_request.merge_commit_sha || github.sha }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --user pipenv
+          pipenv --python python install --dev --skip-lock
+      - name: Run tests
+        run: |
+          pipenv run python -m pytest -q
+      - name: Build package
+        run: |
+          pipenv run python -m build .
+  deliver:
+    # only a merged pull request is released, and only after build passed
+    if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged
+    needs: [build]
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build .
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          # a merge without a version bump (e.g. tooling only) skips the upload
+          skip-existing: true

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: gitlogstats
-Version: 1.1.0
+Version: 1.3.0
 Summary: Track developers' contributions to one or more git repositories within a particular time range.
 Project-URL: Homepage, https://github.com/bloombar/gitlogstats
 Project-URL: Repository, https://github.com/bloombar/gitlogstats.git
@@ -709,7 +709,7 @@ This script calculates the following, for each developer in each repository:
 - number of **files changed**
 - number of **merges** into the analyzed branch
 
-With `--github`, it also reports each developer's GitHub **pull requests** opened, merged and closed without merging (see [GitHub pull requests](#github-pull-requests)).
+With `--github`, it also reports each developer's GitHub **pull requests** opened, merged, closed without merging and merged by themselves (see [GitHub pull requests](#github-pull-requests)).
 
 The results can be formatted as `csv`, `json`, or `markdown`.
 
@@ -751,8 +751,9 @@ options:
                         The branch to parse, if not the default branch
   -v, --verbose         Whether to output debugging info
   -c, --clean           Remove contributors without any contribuition
-  --github              Also report GitHub pull requests opened, merged and
-                        closed per contributor, and match GitHub users to git
+  --github              Also report GitHub pull requests opened, merged,
+                        closed and self-merged per contributor, with their git
+                        and GitHub emails, and match GitHub users to git
                         authors. Needs the GitHub CLI (gh), signed in
 ```
 
@@ -836,14 +837,17 @@ gitlogstats -rf repos.txt -c
 
 ### GitHub pull requests
 
-Add `--github` to also count each contributor's pull requests. Four columns are appended to every output format:
+Add `--github` to also count each contributor's pull requests. Seven columns are appended to every output format:
 
-| Column                | Meaning                                                                                               |
-| --------------------- | ----------------------------------------------------------------------------------------------------- |
-| `github_username`     | the GitHub account matched to the contributor (never the display name), so you can check the matching |
-| `prs_opened`          | pull requests they opened in the date range, whatever their state now (drafts included)               |
-| `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too) |
-| `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                        |
+| Column                | Meaning                                                                                                 |
+| --------------------- | ------------------------------------------------------------------------------------------------------- |
+| `github_username`     | the GitHub account matched to the contributor (never the display name), so you can check the matching   |
+| `prs_opened`          | pull requests they opened in the date range, whatever their state now (drafts included)                 |
+| `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too)   |
+| `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                          |
+| `prs_self_merged`     | pull requests they authored and also merged themselves, merged in the date range (also in `prs_merged`) |
+| `git_email`           | every distinct author email of the git names combined into the row, sorted alphabetically (ignoring case) and separated by `; `; empty for a GitHub-only row |
+| `github_email`        | the public email on the matched GitHub profile; empty when the profile has none (GitHub does not reveal private emails) or no account matched |
 
 ```
 gitlogstats -r https://github.com/bloombar/gitlogstats.git --github
@@ -856,7 +860,7 @@ gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install
 gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.
 ```
 
-**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics.
+**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics. When GitHub could not be asked, `git_email` is still filled in and `github_email` is empty. The emails come from the whole history of the branch, not only from commits in the date range.
 
 **Matching GitHub users to git authors.** Each git author name is compared with the GitHub users active in the repository, trying these in order and stopping at the first that finds exactly one user:
 

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/Pipfile

@@ -5,8 +5,6 @@ name = "pypi"
 
 [packages]
 gitlogstats = {editable = true, path = "."}
-pytest = "*"
-build = "*"
 
 [dev-packages]
 build = "*"

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/Pipfile.lock

@@ -1,7 +1,7 @@
 {
     "_meta": {
         "hash": {
-            "sha256": "70462452caf90504e4b0e1fa21f9c94c9ab312ca80771fa5d2d656e939a719aa"
+            "sha256": "d1fee7a304fa34eaf74ad0dd93b88859d18b03c32476298928a490a03ec616e8"
         },
         "pipfile-spec": 6,
         "requires": {
@@ -16,67 +16,9 @@
         ]
     },
     "default": {
-        "build": {
-            "hashes": [
-                "sha256:51cc11666391ab6f092070437ac747002ff46f3e4113a3622177ee6b488bfc53",
-                "sha256:ecd351a4be9d35a9eaaba244a7687143c9c7d4aea6ac964e7e7ddab20cbcf4e7"
-            ],
-            "index": "pypi",
-            "markers": "python_version >= '3.10'",
-            "version": "==1.6.1"
-        },
         "gitlogstats": {
             "editable": true,
             "path": "."
-        },
-        "iniconfig": {
-            "hashes": [
-                "sha256:67f4b9c50da0dedf52af349e7749a80a9057a5031199791b906c3bb3ae878960",
-                "sha256:9121e2c1fdb355232495be3194c8dfe87ccc2d5dee45947b78e68f499790d7a7"
-            ],
-            "markers": "python_version >= '3.10'",
-            "version": "==2.3.1"
-        },
-        "packaging": {
-            "hashes": [
-                "sha256:94edc256424af38762eb31306eed28beb9f0efc50a8837492c9d6fd6004aed79",
-                "sha256:d7193f7c8e4e93f444fde0262bf90af30e16fa0ad0ad44cb553c87339b23cd1c"
-            ],
-            "markers": "python_version >= '3.9'",
-            "version": "==26.3"
-        },
-        "pluggy": {
-            "hashes": [
-                "sha256:7dd7b0d8832ba3cb632c306926ded123429211b83641b35dc5c41ad2d34f9bec",
-                "sha256:d1eaa46ebb595891b860ab086b4d09c8588af65ebd4361b8e8f4bb8920b90ba8"
-            ],
-            "markers": "python_version >= '3.10'",
-            "version": "==1.7.0"
-        },
-        "pygments": {
-            "hashes": [
-                "sha256:2363c69b61c4a97c838da3b130dcd6468f4848992b21a82f2a63ec34377137d9",
-                "sha256:610ca751c9bc2492b38eb9a38a7fbc93edbbb2d7182edaf34e66ae493dee5c8c"
-            ],
-            "markers": "python_version >= '3.9'",
-            "version": "==2.21.0"
-        },
-        "pyproject-hooks": {
-            "hashes": [
-                "sha256:5fc53fdac9f7bd63fbcdc868fb5f90b4784d78a53a3d3388cd738b807441a20b",
-                "sha256:defda19b854fa0d3bd4f76ea4ddcba8abd7dcfcdd585a6690ade050744fc5f43"
-            ],
-            "markers": "python_version >= '3.8'",
-            "version": "==1.3.3"
-        },
-        "pytest": {
-            "hashes": [
-                "sha256:1088fbde8f2b49d95a549a195707afa7a76a3ce9bcadc26b6d71f0ffda5fe313",
-                "sha256:37a86b45efb9a47a61a36449063e8e18d0cab3161329fc099eb21783169c4f0c"
-            ],
-            "index": "pypi",
-            "markers": "python_version >= '3.10'",
-            "version": "==9.1.1"
         }
     },
     "develop": {

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/README.md

@@ -12,7 +12,7 @@ This script calculates the following, for each developer in each repository:
 - number of **files changed**
 - number of **merges** into the analyzed branch
 
-With `--github`, it also reports each developer's GitHub **pull requests** opened, merged and closed without merging (see [GitHub pull requests](#github-pull-requests)).
+With `--github`, it also reports each developer's GitHub **pull requests** opened, merged, closed without merging and merged by themselves (see [GitHub pull requests](#github-pull-requests)).
 
 The results can be formatted as `csv`, `json`, or `markdown`.
 
@@ -54,8 +54,9 @@ options:
                         The branch to parse, if not the default branch
   -v, --verbose         Whether to output debugging info
   -c, --clean           Remove contributors without any contribuition
-  --github              Also report GitHub pull requests opened, merged and
-                        closed per contributor, and match GitHub users to git
+  --github              Also report GitHub pull requests opened, merged,
+                        closed and self-merged per contributor, with their git
+                        and GitHub emails, and match GitHub users to git
                         authors. Needs the GitHub CLI (gh), signed in
 ```
 
@@ -139,14 +140,17 @@ gitlogstats -rf repos.txt -c
 
 ### GitHub pull requests
 
-Add `--github` to also count each contributor's pull requests. Four columns are appended to every output format:
+Add `--github` to also count each contributor's pull requests. Seven columns are appended to every output format:
 
-| Column                | Meaning                                                                                               |
-| --------------------- | ----------------------------------------------------------------------------------------------------- |
-| `github_username`     | the GitHub account matched to the contributor (never the display name), so you can check the matching |
-| `prs_opened`          | pull requests they opened in the date range, whatever their state now (drafts included)               |
-| `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too) |
-| `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                        |
+| Column                | Meaning                                                                                                 |
+| --------------------- | ------------------------------------------------------------------------------------------------------- |
+| `github_username`     | the GitHub account matched to the contributor (never the display name), so you can check the matching   |
+| `prs_opened`          | pull requests they opened in the date range, whatever their state now (drafts included)                 |
+| `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too)   |
+| `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                          |
+| `prs_self_merged`     | pull requests they authored and also merged themselves, merged in the date range (also in `prs_merged`) |
+| `git_email`           | every distinct author email of the git names combined into the row, sorted alphabetically (ignoring case) and separated by `; `; empty for a GitHub-only row |
+| `github_email`        | the public email on the matched GitHub profile; empty when the profile has none (GitHub does not reveal private emails) or no account matched |
 
 ```
 gitlogstats -r https://github.com/bloombar/gitlogstats.git --github
@@ -159,7 +163,7 @@ gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install
 gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.
 ```
 
-**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics.
+**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics. When GitHub could not be asked, `git_email` is still filled in and `github_email` is empty. The emails come from the whole history of the branch, not only from commits in the date range.
 
 **Matching GitHub users to git authors.** Each git author name is compared with the GitHub users active in the repository, trying these in order and stopping at the first that finds exactly one user:
 

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/docs/SPEC.md

@@ -114,6 +114,18 @@ If a tier finds several GitHub users for one identity, that tier is skipped as a
 
 **Status:** Done
 
+#### STAT-12 Self-merged pull requests
+
+With `--github`, for each contributor, the number of pull requests they authored and also merged themselves (the GitHub user who merged the pull request is its author, ignoring case), with a merge time (`merged_at`) in the date range. Reported in a `prs_self_merged` column, appended after `prs_closed_unmerged`. Every self-merged pull request is also counted in `prs_merged` (STAT-9), so `prs_self_merged` is never larger than `prs_merged`. A merged pull request whose merger GitHub does not report (e.g. a deleted account) is not counted as self-merged. `-b` and `-s/-e` apply as for `prs_merged`.
+
+**Status:** Done
+
+#### STAT-13 Contributor email addresses
+
+With `--github`, every row also reports the contributor's email addresses in two columns appended after `prs_self_merged`: `git_email` lists every distinct author email of the git identities combined into the row (STAT-11), sorted alphabetically (ignoring case) and separated by `; `, and is empty for a GitHub-only row; `github_email` is the public email on the matched GitHub user's profile, and is empty when the profile has none (GitHub does not reveal private emails) or the row has no GitHub user. Emails come from the whole history of the analyzed branch, like the contributor list, not only from commits in the date range. When GitHub statistics are unavailable for a repository (CLI-3), `git_email` is still filled in and `github_email` is empty (`null` in JSON). Without `--github`, neither column appears.
+
+**Status:** Done
+
 ### 3. Filtering
 
 #### FILT-1 Date range
@@ -144,7 +156,7 @@ By default, contributors with no activity in the date range are listed with zero
 
 #### OUT-1 CSV output
 
-`-f csv` (the default) prints a header row followed by one row per contributor per repository, with fields `username, repository, start_date, end_date, commits, insertions, deletions, files, merges`. New fields are added at the end so existing column positions do not change. Values containing commas, quotes or line breaks are quoted. The header is printed even when there are no rows, and the output ends with a single newline. With `--github`, the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged` are appended, and are in the header even when there are no rows (CLI-3).
+`-f csv` (the default) prints a header row followed by one row per contributor per repository, with fields `username, repository, start_date, end_date, commits, insertions, deletions, files, merges`. New fields are added at the end so existing column positions do not change. Values containing commas, quotes or line breaks are quoted. The header is printed even when there are no rows, and the output ends with a single newline. With `--github`, the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged, git_email, github_email` are appended, and are in the header even when there are no rows (CLI-3).
 
 **Status:** Done
 
@@ -188,12 +200,12 @@ Invalid dates, and a start date after the end date, are rejected with a usage er
 
 #### CLI-3 GitHub pull-request statistics
 
-`--github` adds GitHub pull-request statistics (STAT-8 to STAT-11) for repositories hosted on github.com, appending the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged` to every output format. Without `--github`, the output and behaviour are unchanged, GitHub is never contacted and the GitHub CLI (`gh`) is not needed. With `--github`, the GitHub API is called through `gh api`, so `gh` must be installed and signed in. This is checked before any repository is cloned; if it fails, nothing is printed to standard output, the tool exits with status 1, and one plain message on standard error says why and what to do — no stack trace:
+`--github` adds GitHub pull-request statistics (STAT-8 to STAT-12) and contributor emails (STAT-13) for repositories hosted on github.com, appending the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged, git_email, github_email` to every output format. Without `--github`, the output and behaviour are unchanged, GitHub is never contacted and the GitHub CLI (`gh`) is not needed. With `--github`, the GitHub API is called through `gh api`, so `gh` must be installed and signed in. This is checked before any repository is cloned; if it fails, nothing is printed to standard output, the tool exits with status 1, and one plain message on standard error says why and what to do — no stack trace:
 
 - `gh` not found: `gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install it from https://cli.github.com and run 'gh auth login', or run without --github.`
 - `gh` not signed in (`gh auth status` fails): `gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.`
 
-The other options apply to pull requests as follows: `-s/-e` filter each count by its own timestamp, using the same inclusive local-time range as FILT-1; `-u` selects the combined row whose author names, emails or GitHub username match exactly (the username ignoring case); `-b` counts only pull requests whose base branch is that branch, and without `-b` every pull request counts; `-c` removes only rows with neither git nor pull-request activity; `-x` does not apply. For a repository not on github.com, or when GitHub cannot be reached for one repository (no network, rate limit, private repository without access), the git statistics are still reported, the four GitHub columns are empty (`null` in JSON) rather than zero, and the reason is printed to standard error.
+The other options apply to pull requests as follows: `-s/-e` filter each count by its own timestamp, using the same inclusive local-time range as FILT-1; `-u` selects the combined row whose author names, emails or GitHub username match exactly (the username ignoring case); `-b` counts only pull requests whose base branch is that branch, and without `-b` every pull request counts; `-c` removes only rows with neither git nor pull-request activity; `-x` does not apply. For a repository not on github.com, or when GitHub cannot be reached for one repository (no network, rate limit, private repository without access), the git statistics are still reported, the GitHub columns (including `github_email`) are empty (`null` in JSON) rather than zero while `git_email` is still filled in (STAT-13), and the reason is printed to standard error.
 
 **Status:** Done
 
@@ -207,7 +219,7 @@ The tool installs with `pip install gitlogstats`, which provides a `gitlogstats`
 
 #### PKG-2 Continuous integration and release
 
-GitHub Actions builds the package on every push, on Python 3.9 and 3.11, and publishes it to PyPI.
+GitHub Actions builds the package on Python 3.9 and 3.11 for every pull request into `master` and every push to `master`. It publishes to PyPI only when a pull request is merged into `master` and the build of the merged code passes; pushes to other branches publish nothing. A merge whose version is already on PyPI (no version bump) skips the upload instead of failing.
 
 **Status:** Done
 
@@ -219,9 +231,9 @@ Unit tests cover parsing and formatting, and integration tests build real git re
 
 #### PKG-4 Run tests in CI
 
-The CI workflow runs the test suite on every push and stops the release if any test fails. (Today it builds and publishes without running tests.)
+The CI workflow runs the Python test suite (`pytest`) on every pull request into `master` and every push to `master`, and on the merged code before a release; a failing test stops the release.
 
-**Status:** Todo
+**Status:** Done
 
 ### 7. Future Work
 

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "gitlogstats"
 description = "Track developers' contributions to one or more git repositories within a particular time range."
-version = "1.1.0"
+version = "1.3.0"
 authors = [
   { name="Tobody Tothing", email="nobody.nothing@nowhere.com" },
 ]

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/scripts/board/manifest.yaml

@@ -19,16 +19,16 @@
   status: Done
 - id: CLI-3
   title: GitHub pull-request statistics
-  full: "--github adds GitHub pull-request statistics (STAT-8 to STAT-11) for
-    repositories hosted on github.com, appending the columns github_username,
-    prs_opened, prs_merged, prs_closed_unmerged to every output format. Without
-    --github, the output and behaviour are unchanged, GitHub is never contacted
-    and the GitHub CLI (gh) is not needed. With --github, the GitHub API is
-    called through gh api, so gh must be installed and signed in. This is
-    checked before any repository is cloned; if it fails, nothing is printed to
-    standard output, the tool exits with status 1, and one plain message on
-    standard error says why and what to do — no stack trace: gh not found:
-    gitlogstats: --github needs the GitHub CLI…"
+  full: --github adds GitHub pull-request statistics (STAT-8 to STAT-12) and
+    contributor emails (STAT-13) for repositories hosted on github.com,
+    appending the columns github_username, prs_opened, prs_merged,
+    prs_closed_unmerged, prs_self_merged, git_email, github_email to every
+    output format. Without --github, the output and behaviour are unchanged,
+    GitHub is never contacted and the GitHub CLI (gh) is not needed. With
+    --github, the GitHub API is called through gh api, so gh must be installed
+    and signed in. This is checked before any repository is cloned; if it fails,
+    nothing is printed to standard output, the tool exits with status 1, and one
+    plain message on standard error says why and what to do…
   section: §5 Command-Line Interface
   family: CLI
   phase: 1
@@ -89,8 +89,8 @@
     containing commas, quotes or line breaks are quoted. The header is printed
     even when there are no rows, and the output ends with a single newline. With
     --github, the columns github_username, prs_opened, prs_merged,
-    prs_closed_unmerged are appended, and are in the header even when there are
-    no rows (CLI-3).
+    prs_closed_unmerged, prs_self_merged, git_email, github_email are appended,
+    and are in the header even when there are no rows (CLI-3).
   section: §4 Output
   family: OUT
   phase: 1
@@ -141,8 +141,11 @@
   status: Done
 - id: PKG-2
   title: Continuous integration and release
-  full: GitHub Actions builds the package on every push, on Python 3.9 and 3.11,
-    and publishes it to PyPI.
+  full: GitHub Actions builds the package on Python 3.9 and 3.11 for every pull
+    request into master and every push to master. It publishes to PyPI only when
+    a pull request is merged into master and the build of the merged code
+    passes; pushes to other branches publish nothing. A merge whose version is
+    already on PyPI (no version bump) skips the upload instead of failing.
   section: §6 Packaging & Quality
   family: PKG
   phase: 1
@@ -159,12 +162,13 @@
   status: Done
 - id: PKG-4
   title: Run tests in CI
-  full: The CI workflow runs the test suite on every push and stops the release if
-    any test fails. (Today it builds and publishes without running tests.)
+  full: The CI workflow runs the Python test suite (pytest) on every pull request
+    into master and every push to master, and on the merged code before a
+    release; a failing test stops the release.
   section: §6 Packaging & Quality
   family: PKG
   phase: 1
-  status: Todo
+  status: Done
 - id: REPO-1
   title: Single repository
   full: -r/--repository <url> analyzes one repository. Any URL or path that git
@@ -329,6 +333,37 @@
   family: STAT
   phase: 1
   status: Done
+- id: STAT-12
+  title: Self-merged pull requests
+  full: With --github, for each contributor, the number of pull requests they
+    authored and also merged themselves (the GitHub user who merged the pull
+    request is its author, ignoring case), with a merge time (merged_at) in the
+    date range. Reported in a prs_self_merged column, appended after
+    prs_closed_unmerged. Every self-merged pull request is also counted in
+    prs_merged (STAT-9), so prs_self_merged is never larger than prs_merged. A
+    merged pull request whose merger GitHub does not report (e.g. a deleted
+    account) is not counted as self-merged. -b and -s/-e apply as for
+    prs_merged.
+  section: §2 Contribution Statistics
+  family: STAT
+  phase: 1
+  status: Done
+- id: STAT-13
+  title: Contributor email addresses
+  full: "With --github, every row also reports the contributor's email addresses
+    in two columns appended after prs_self_merged: git_email lists every
+    distinct author email of the git identities combined into the row (STAT-11),
+    sorted alphabetically (ignoring case) and separated by ; , and is empty for
+    a GitHub-only row; github_email is the public email on the matched GitHub
+    user's profile, and is empty when the profile has none (GitHub does not
+    reveal private emails) or the row has no GitHub user. Emails come from the
+    whole history of the analyzed branch, like the contributor list, not only
+    from commits in the date range. When GitHub statistics are unavailable for a
+    repository (CLI-3), git_email is…"
+  section: §2 Contribution Statistics
+  family: STAT
+  phase: 1
+  status: Done
 - id: FUTURE-author-date-filtering
   title: Author-date filtering
   full: Author-date filtering — offer filtering by author date, so rebased or

{gitlogstats-1.1.0 → gitlogstats-1.3.0}/src/gitlogstats/__main__.py

@@ -6,7 +6,7 @@ import re
 import sys
 from . import GitLogsParser
 from .git_logs_parser import FIELDNAMES
-from .github import GITHUB_FIELDNAMES, GitHubUnavailable, check_gh
+from .github import EMAIL_FIELDNAMES, GITHUB_FIELDNAMES, GitHubUnavailable, check_gh
 from .github_stats import github_rows
 
 
@@ -141,9 +141,9 @@ def main():
     )
     parser.add_argument(
         "--github",
-        help="Also report GitHub pull requests opened, merged and closed per "
-        "contributor, and match GitHub users to git authors. Needs the GitHub CLI "
-        "(gh), signed in",
+        help="Also report GitHub pull requests opened, merged, closed and "
+        "self-merged per contributor, with their git and GitHub emails, and "
+        "match GitHub users to git authors. Needs the GitHub CLI (gh), signed in",
         default=False,
         action="store_true",
     )
@@ -233,7 +233,9 @@ def main():
     # emit a single table (or JSON array) covering all repositories
     if last_parser is not None:
         # an empty CSV table still gets the GitHub columns with --github
-        fieldnames = FIELDNAMES + GITHUB_FIELDNAMES if args.github else None
+        fieldnames = (
+            FIELDNAMES + GITHUB_FIELDNAMES + EMAIL_FIELDNAMES if args.github else None
+        )
         output = last_parser.format_results(all_results, args.format, fieldnames)
         # end with exactly one newline: CSV and Markdown output already has one
         print(output, end="" if output.endswith("\n") else "\n")