Extend and improve testing instructions

Now also documents testing of how the commit history is used to infer
committer addition times. To make that work, we use a clean members-test
directory that is guaranteed to not exist in the upstream repo, so it
has a clean history that isn't conflicting.

Author: infinisil

scripts/README.md

@@ -36,27 +36,32 @@ Once you have the above setup (or got @infinisil to add yourself to his), you ha
 This script has no external effects and as such can be easily tested by running:
 
 ```bash
-scripts/sync.sh infinisil-test-org actors members
+scripts/sync.sh infinisil-test-org actors members-test
 ```
 
-Check that it synchronises the files in the `members` directory with the team members of the `actors` team.
+Check that it synchronises the files in the `members-test` directory with the team members of the `actors` team.
 
 ## `retire.sh`
 
 This script has external effects and as such needs a bit more care when testing.
 
 ### Setup (important!)
 
-To avoid other users getting pings, ensure that the `members` directory contains only a simulated new user and your own user (simulated to have been added over a year ago), then commit and push it for testing:
+To avoid other users getting pings, ensure that the `members-test` directory contains only simulated new users and your own user (simulated to have been added over a year ago), then commit and push it for testing:
 
 ```bash
 me=$(gh api /user --jq .login)
 git switch -C "test-$me"
-rm -rf members
-mkdir members
-date +%F > "members/github"
-date --date="1 year ago 1 day ago" +%F > "members/$me"
-git add members
+rm -rf members-test
+mkdir -p members-test
+
+touch members-test/"$me"
+date +%F > "members-test/new-committer-1"
+git add members-test
+GIT_COMMITTER_DATE=$(date --date @0) git commit -m testing
+
+touch "members-test/new-committer-2"
+git add members-test
 git commit -m testing
 git push -f -u origin HEAD
 ```
@@ -67,40 +72,40 @@ The following sequence tests all code paths:
 
 1. Run the script with the `active` repo argument to simulate CI running without inactive users:
    ```bash
-   scripts/retire.sh infinisil-test-org active nixpkgs-committers members 'yesterday 1 month ago'
+   scripts/retire.sh infinisil-test-org active nixpkgs-committers members-test 'yesterday 1 month ago'
    ```
 
    Check that no PR would be opened.
 2. Run the script with the `empty` repo argument to simulate CI running with inactive users:
 
    ```bash
-   scripts/retire.sh infinisil-test-org empty nixpkgs-committers members 'yesterday 1 month ago'
+   scripts/retire.sh infinisil-test-org empty nixpkgs-committers members-test 'yesterday 1 month ago'
    ```
 
-   Check that it would only create a PR for your own user and not the "github" user before running it again with `PROD=1` to actually do it:
+   Check that it would only create a PR for your own user and not the "new-committer-1" or "new-committer-2" user before running it again with `PROD=1` to actually do it:
 
    ```bash
-   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members 'yesterday 1 month ago'
+   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members-test 'yesterday 1 month ago'
    ```
 
    Check that it created the PR appropriately.
    You can undo this step by closing the PR.
 3. Run it again to simulate CI running again later:
    ```bash
-   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members 'yesterday 1 month ago'
+   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members-test 'yesterday 1 month ago'
    ```
    Check that no other PR is opened.
 4. Run it again with `now` as the date to simulate the time interval passing:
    ```bash
-   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members now
+   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members-test now
    ```
    Check that it undrafted the previous PR and posted an appropriate comment.
 5. Run it again to simulate CI running again later:
    ```bash
-   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members now
+   PROD=1 scripts/retire.sh infinisil-test-org empty nixpkgs-committers members-test now
    ```
 6. Reset by marking the PR as a draft again.
 7. Run it again with the `active` repo argument to simulate activity during the time interval:
    ```bash
-   PROD=1 scripts/retire.sh infinisil-test-org active nixpkgs-committers members now
+   PROD=1 scripts/retire.sh infinisil-test-org active nixpkgs-committers members-test now
    ```