Skip to content

Commit

Permalink
Relocate zsh sources (#28)
Browse files Browse the repository at this point in the history
# Changes

## Primary change

Move zsh sources to `src/zsh/`

## Supporting changes

Split GitHub Actions by what is being done or built
  • Loading branch information
kkrull authored Jul 8, 2024
1 parent 8fbaccb commit 9a1d798
Show file tree
Hide file tree
Showing 34 changed files with 45 additions and 38 deletions.
30 changes: 0 additions & 30 deletions .github/workflows/build.yml

This file was deleted.

19 changes: 19 additions & 0 deletions .github/workflows/pandoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Pandoc Build

on:
pull_request:
push:
branches: [main]
workflow_dispatch:

jobs:
manuals-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pandoc/actions/setup@main
with:
version: 3.2

- name: Build
run: make -C man all
18 changes: 18 additions & 0 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Pre-commit checks

on:
pull_request:
push:
branches: [main]
workflow_dispatch:

jobs:
checks-run:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"

- uses: pre-commit/action@v3.0.1
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,23 @@ PRECOMMIT ?= pre-commit
.PHONY: all clean install test uninstall
all: #> Build everything
$(MAKE) -C man all
$(MAKE) -C src all
$(MAKE) -C src/zsh all

clean: pre-commit-clean #> Remove files built by running make earlier
$(MAKE) -C man clean
$(MAKE) -C src clean
$(MAKE) -C src/zsh clean

install: #> Install programs and manuals made here
$(MAKE) -C man install
$(MAKE) -C src install
$(MAKE) -C src/zsh install

test: pre-commit-run #> Run all tests and checks
$(MAKE) -C man test
$(MAKE) -C src test
$(MAKE) -C src/zsh test

uninstall: #> Uninstall programs and manuals made here
$(MAKE) -C man uninstall
$(MAKE) -C src uninstall
$(MAKE) -C src/zsh uninstall

#. OTHER TARGETS

Expand Down
2 changes: 1 addition & 1 deletion doc/decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Source: <https://unix.stackexchange.com/a/365417/37734>

#### Location of shared code

- Put shared code in `src/lib/`.
- Put shared code in `lib/`.
- Gather together shared functions that operate on the same bounded context (e.g. the same data).
Explore a convention of making that bounded context the first parameter in each function.
- Name files according to their bounded context.
Expand Down
2 changes: 1 addition & 1 deletion doc/task-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Manuals are written in Markdown. This project uses Pandoc to generate `groff` m
Markdown manuals in `man/groff/` and `man/markdown/`, respectively. The Markdown manuals are
included in the repository, for ease of reading on GitHub.

### Targets in `src/`
### Targets in `src/zsh`

There isn't anything to build, since the programs are all scripts. However, there are conventional
targets to install symlinks to the user's `PATH`.
Expand Down
2 changes: 1 addition & 1 deletion doc/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Tools used by some part of this project's build, deployment, or development proc

- `Makefile`: targets to build everything and tasks to help set up your environment
- `man/Makefile`: targets to build manuals
- `src/Makefile`: targets to build programs
- `src/zsh/Makefile`: targets to build programs with scripts

## Homebrew

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 9a1d798

Please sign in to comment.