Skip to content

✂ [just] refactor into files #11

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 19, 2025
Merged

✂ [just] refactor into files #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
82 changes: 82 additions & 0 deletions .just/compliance.just
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# our own compliance check
[group('Compliance')]
compliance_check:
#!/usr/bin/env bash
set -euo pipefail # strict mode without tracing

echo "{{BLUE}}Chicks' repo compliance check...{{NORMAL}}"

if [[ -e README.md ]]; then
echo "{{GREEN}}You have a README.md, thank you.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a README.md, hmmmm, why is this repo here?{{NORMAL}}"
fi

if [[ -e LICENSE ]]; then
echo "{{GREEN}}[gh] You have a license, good for you.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a license, are you feeling ok?{{NORMAL}}"
fi

if [[ -e .github/CODE_OF_CONDUCT.md ]]; then
echo "{{GREEN}}[gh] You have a Code of Conduct, respect.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a Code of Conduct. So anything goes around here?{{NORMAL}}"
fi

if [[ -e .github/CONTRIBUTING.md ]]; then
echo "{{GREEN}}[gh] You have a Contributing Guide, how giving.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a Contributing Guide. Hopefully they'll figure it out on their own.{{NORMAL}}"
fi

if [[ -e .github/SECURITY.md ]]; then
echo "{{GREEN}}[gh] You have a Security Guide, very comforting.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a Security Guide. Don't call the cops.{{NORMAL}}"
fi

if [[ -e .github/pull_request_template.md ]]; then
echo "{{GREEN}}[gh] You have a pull request template, not too pushy.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a pull request template. Prepare for anything.{{NORMAL}}"
fi

if [[ -d .github/ISSUE_TEMPLATE ]]; then
echo "{{GREEN}}[gh] You have Issue Templates, life is good.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have Issue Templates. I must take issue with that.{{NORMAL}}"
fi

if [[ $(gh repo view --json description | jq -r '.description' | wc -c) -gt 16 ]]; then
echo "{{GREEN}}[gh] You have a repo description, more evidence that you are undescribable.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a repo description, can you write a word or two please?{{NORMAL}}"
fi

# github also checks for something about the repo admins

if [[ -e .github/CODEOWNERS ]]; then
echo "{{GREEN}}You have a CODEOWNERS file, in DEED.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a CODEOWNERS file. Does anyone want to make a claim?{{NORMAL}}"
fi

if [[ -e .gitignore ]]; then
echo "{{GREEN}}You have a .gitignore file, so there will be less debris in your future.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a .gitignore file. I expect you to keep ignoring my advice!{{NORMAL}}"
fi

if [[ -e .gitattributes ]]; then
echo "{{GREEN}}You have a .gitattributes file, keeping metadata and line endings clean too.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a .gitattributes file. Did you hear what happens when binaries and text files get together?{{NORMAL}}"
fi

if [[ -e justfile ]]; then
echo "{{GREEN}}You have a {{BLUE}}justfile{{GREEN}}, spreading justice and automation a little further.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a justfile. Feeling the FOMO yet?{{NORMAL}}"
echo "{{RED}}And this should not be possible. Tell me how you got here.{{NORMAL}}"
fi
106 changes: 106 additions & 0 deletions .just/gh-process.just
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# git/gh process justfile

# some useful variables
host := `uname -n`
release_branch := "main"

# thanks to https://stackoverflow.com/a/7293026/2002471 for the perfect git incantation
last_commit_message := `git log -1 --pretty=%B | grep '.'`

# escape from branch, back to starting point
[group('Process')]
sync:
git checkout {{ release_branch }}
git pull
git stp

# PR create 3.1
[group('Process')]
pr: _on_a_branch
#!/usr/bin/env bash
set -euxo pipefail # strict mode

git stp
git pushup

set +x # leave tracing off...

bodyfile=$(mktemp /tmp/justfile.XXXXXX)

echo "## Done:" >> $bodyfile
echo "" >> $bodyfile
echo "- {{ last_commit_message }}" >> $bodyfile
echo "" >> $bodyfile
echo "" >> $bodyfile
echo "(Automated in \`justfile\`.)" >> $bodyfile

echo ''
cat "$bodyfile"
echo ''

gh pr create --title "{{ last_commit_message }}" --body-file "$bodyfile"
rm "$bodyfile"

if [[ ! -e ".github/workflows" ]]; then
echo "{{BLUE}}there are no workflows in this repo so there are no PR checks to watch{{NORMAL}}"
exit 0
fi

echo "{{BLUE}}sleeping for 10s because github is lazy with their API{{NORMAL}}"
sleep 10
gh pr checks --watch

# merge PR and return to starting point
[group('Process')]
merge: _on_a_branch && sync
gh pr merge -s -d
# `&& sync` is mostly redundant, but just in case

# start a new branch
[group('Process')]
branch branchname: _main_branch
#!/usr/bin/env bash
NOW=`just utcdate`
git co -b "$USER/$NOW-{{ branchname }}"

# view PR in web browser
[group('Process')]
prweb: _on_a_branch
gh pr view --web

# error if not on a git branch
[group('sanity check')]
[no-cd]
_on_a_branch:
#!/bin/bash

# thanks to https://stackoverflow.com/a/12142066/2002471

if [[ $(git rev-parse --abbrev-ref HEAD) == "{{ release_branch }}" ]]; then
echo "{{RED}}You are on branch '{{ release_branch }}' (the release branch) so you are not ready to start a PR.{{NORMAL}}"
exit 100
fi

# error if not on the release branch
[group('sanity check')]
[no-cd]
_main_branch:
#!/bin/bash

# thanks to https://stackoverflow.com/a/12142066/2002471

if [[ ! $(git rev-parse --abbrev-ref HEAD) == "{{ release_branch }}" ]]; then
echo "You are on a branch that is not the release branch so you are not ready to start a new branch."
exit 100
fi

# print UTC date in ISO format
[group('Utility')]
[no-cd]
@utcdate:
TZ=UTC date +"%Y-%m-%d"

# make a release
[group('Process')]
release rel_version:
gh release create {{rel_version}} --generate-notes
189 changes: 2 additions & 187 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,111 +1,14 @@
# project justfile

# some useful variables
host := `uname -n`
release_branch := "main"

# thanks to https://stackoverflow.com/a/7293026/2002471 for the perfect git incantation
last_commit_message := `git log -1 --pretty=%B | grep '.'`
import? '.just/compliance.just'
import? '.just/gh-process.just'

# list recipes (default works without naming it)
[group('example')]
list:
just --list
@echo "{{GREEN}}Your justfile is waiting for more scripts and snippets{{NORMAL}}"

# escape from branch, back to starting point
[group('Process')]
sync:
git checkout {{ release_branch }}
git pull
git stp

# PR create 3.0
[group('Process')]
pr: _on_a_branch
#!/usr/bin/env bash
set -euxo pipefail # strict mode

git stp
git pushup

set +x # leave tracing off...

bodyfile=$(mktemp /tmp/justfile.XXXXXX)

echo "## Done:" >> $bodyfile
echo "" >> $bodyfile
echo "- {{ last_commit_message }}" >> $bodyfile
echo "" >> $bodyfile
echo "" >> $bodyfile
echo "(Automated in \`justfile\`.)" >> $bodyfile

echo ''
cat "$bodyfile"
echo ''

gh pr create --title "{{ last_commit_message }}" --body-file "$bodyfile"
rm "$bodyfile"

if [[ ! -e ".github/workflows" ]]; then
echo "{{BLUE}}there are no workflows in this repo so there are no PR checks to watch{{NORMAL}}"
exit 0
fi

echo "{{BLUE}}sleeping for 10s because github is lazy with their API{{NORMAL}}"
sleep 10
gh pr checks --watch

# merge PR and return to starting point
[group('Process')]
merge: _on_a_branch && sync
gh pr merge -s -d
# `&& sync` is mostly redundant, but just in case

# start a new branch
[group('Process')]
branch branchname: _main_branch
#!/usr/bin/env bash
NOW=`just utcdate`
git co -b "$USER/$NOW-{{ branchname }}"

# view PR in web browser
[group('Process')]
prweb: _on_a_branch
gh pr view --web

# error if not on a git branch
[group('sanity check')]
[no-cd]
_on_a_branch:
#!/bin/bash

# thanks to https://stackoverflow.com/a/12142066/2002471

if [[ $(git rev-parse --abbrev-ref HEAD) == "{{ release_branch }}" ]]; then
echo "{{RED}}You are on branch '{{ release_branch }}' (the release branch) so you are not ready to start a PR.{{NORMAL}}"
exit 100
fi

# error if not on the release branch
[group('sanity check')]
[no-cd]
_main_branch:
#!/bin/bash

# thanks to https://stackoverflow.com/a/12142066/2002471

if [[ ! $(git rev-parse --abbrev-ref HEAD) == "{{ release_branch }}" ]]; then
echo "You are on a branch that is not the release branch so you are not ready to start a new branch."
exit 100
fi

# print UTC date in ISO format
[group('Utility')]
[no-cd]
@utcdate:
TZ=UTC date +"%Y-%m-%d"

# generate a clean README
[group('Utility')]
[no-cd]
Expand Down Expand Up @@ -143,91 +46,3 @@ clean_readme:
- [Getting Support](.github/SUPPORT.md)
- [Security](.github/SECURITY.md)
END_OF_HEREDOC

# our own compliance check
[group('Compliance')]
compliance_check:
#!/usr/bin/env bash
set -euo pipefail # strict mode without tracing

echo "{{BLUE}}Chicks' repo compliance check...{{NORMAL}}"

if [[ -e README.md ]]; then
echo "{{GREEN}}You have a README.md, thank you.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a README.md, hmmmm, why is this repo here?{{NORMAL}}"
fi

if [[ -e LICENSE ]]; then
echo "{{GREEN}}[gh] You have a license, good for you.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a license, are you feeling ok?{{NORMAL}}"
fi

if [[ -e .github/CODE_OF_CONDUCT.md ]]; then
echo "{{GREEN}}[gh] You have a Code of Conduct, respect.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a Code of Conduct. So anything goes around here?{{NORMAL}}"
fi

if [[ -e .github/CONTRIBUTING.md ]]; then
echo "{{GREEN}}[gh] You have a Contributing Guide, how giving.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a Contributing Guide. Hopefully they'll figure it out on their own.{{NORMAL}}"
fi

if [[ -e .github/SECURITY.md ]]; then
echo "{{GREEN}}[gh] You have a Security Guide, very comforting.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a Security Guide. Don't call the cops.{{NORMAL}}"
fi

if [[ -e .github/pull_request_template.md ]]; then
echo "{{GREEN}}[gh] You have a pull request template, not too pushy.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a pull request template. Prepare for anything.{{NORMAL}}"
fi

if [[ -d .github/ISSUE_TEMPLATE ]]; then
echo "{{GREEN}}[gh] You have Issue Templates, life is good.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have Issue Templates. I must take issue with that.{{NORMAL}}"
fi

if [[ $(gh repo view --json description | jq -r '.description' | wc -c) -gt 16 ]]; then
echo "{{GREEN}}[gh] You have a repo description, more evidence that you are undescribable.{{NORMAL}}"
else
echo "{{RED}}[gh] You do NOT have a repo description, can you write a word or two please?{{NORMAL}}"
fi

# github also checks for something about the repo admins

if [[ -e .github/CODEOWNERS ]]; then
echo "{{GREEN}}You have a CODEOWNERS file, in DEED.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a CODEOWNERS file. Does anyone want to make a claim?{{NORMAL}}"
fi

if [[ -e .gitignore ]]; then
echo "{{GREEN}}You have a .gitignore file, so there will be less debris in your future.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a .gitignore file. I expect you to keep ignoring my advice!{{NORMAL}}"
fi

if [[ -e .gitattributes ]]; then
echo "{{GREEN}}You have a .gitattributes file, keeping metadata and line endings clean too.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a .gitattributes file. Did you hear what happens when binaries and text files get together?{{NORMAL}}"
fi

if [[ -e justfile ]]; then
echo "{{GREEN}}You have a {{BLUE}}justfile{{GREEN}}, spreading justice and automation a little further.{{NORMAL}}"
else
echo "{{RED}}You do NOT have a justfile. Feeling the FOMO yet?{{NORMAL}}"
echo "{{RED}}And this should not be possible. Tell me how you got here.{{NORMAL}}"
fi

# make a release
[group('Process')]
release rel_version:
gh release create {{rel_version}} --generate-notes