Skip to content

Commit 9ec0a30

Browse files
authored
🐠 [readme] update CONTRIBUTING with new just recipe (#33)
* 🐠 [readme] update CONTRIBUTING with new just recipe * verified that it will block PR creation * go with v3.7 * add .just/README.md
1 parent 5875f6a commit 9ec0a30

File tree

4 files changed

+18
-8
lines changed

4 files changed

+18
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ Available recipes:
6565
[Process]
6666
branch branchname # start a new branch
6767
merge # merge PR and return to starting point
68-
pr # PR create 3.0
68+
pr # PR create 3.7
69+
pr_checks # watch GHAs then check for Copilot suggestions
6970
prweb # view PR in web browser
7071
release rel_version # make a release
7172
sync # escape from branch, back to starting point

.just/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# .just directory
2+
3+
Just recipe files live in this directory.
4+
5+
The master copy of these project files lives in the
6+
[FINI template-repo](https://github.com/fini-net/template-repo)
7+
and you should be able to copy them into your
8+
project for updates.
9+
10+
We use the [repos-summary script](https://github.com/chicks-net/chicks-home/blob/main/bin/repos-summary)
11+
to see which of our repos need updates of the just files.

.just/gh-process.just

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ sync:
1010
git pull
1111
git stp
1212

13-
# PR create 3.6
13+
# PR create 3.7
1414
[group('Process')]
1515
pr: _has_commits && pr_checks
1616
#!/usr/bin/env bash
1717
set -euxo pipefail # strict mode
18+
set +x # leave tracing off...
1819

1920
# handle optional pre-pr hook (for things like hugo)
2021
if [[ -e ".just/pr-hook.just" ]]; then
@@ -25,8 +26,6 @@ pr: _has_commits && pr_checks
2526
git stp
2627
git pushup
2728

28-
set +x # leave tracing off...
29-
3029
CURRENT_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
3130
#COMMIT_COUNT=$(git cherry -v "{{ release_branch }}" "$CURRENT_BRANCH" | wc -l)
3231

@@ -55,8 +54,8 @@ pr: _has_commits && pr_checks
5554
exit 0
5655
fi
5756

58-
echo "{{BLUE}}sleeping for 10s because github is lazy with their API{{NORMAL}}"
59-
sleep 10
57+
echo "{{BLUE}}sleeping for 8s because github is lazy with their API{{NORMAL}}"
58+
sleep 8
6059

6160
# merge PR and return to starting point
6261
[group('Process')]

.just/pr-hook.just

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44

55
# run this before creating a PR
66
_pr-hook:
7-
exit 1 # TODO: remove in next PR after verification
8-
echo "{{BLUE}}placeholder{{NORMAL}}"
7+
echo "{{BLUE}}placeholder for pr-hook...{{NORMAL}}"

0 commit comments

Comments
 (0)