Add scripts-to-rule-them-all scaffold (closes #4)
Adopt the Scripts to Rule Them All standard for this Hugo site: - script/ POSIX-sh entrypoints (bootstrap, setup, projectname, test, lint, fmt, fmt-check, check, docker, cibuild, precommit, install-precommit). The correctness check (test/lint) is a clean `hugo --minify` production build; fmt/fmt-check run prettier over the repo's own top-level markdown only, leaving content/ untouched. - Makefile targets reduced to thin shims that call script/NAME, plus a convenience serve target for `hugo server`. - Dockerfile on a sha256-pinned alpine base that installs deps via script/bootstrap and runs `make check`, so the image build fails on any formatting or Hugo build error; .dockerignore added. - .gitea/workflows/check.yml runs script/cibuild on push. - README Entrypoints section documenting the scripts.
This commit was merged in pull request #5.
This commit is contained in:
35
README.md
35
README.md
@@ -4,7 +4,8 @@ Las Vegas Meshtastic and LoRa community website.
|
||||
|
||||
## About
|
||||
|
||||
This site provides information about the Las Vegas mesh networking community, including:
|
||||
This site provides information about the Las Vegas mesh networking community,
|
||||
including:
|
||||
|
||||
- Mesh channel configurations
|
||||
- Community coordination (Discord, Signal)
|
||||
@@ -13,11 +14,13 @@ This site provides information about the Las Vegas mesh networking community, in
|
||||
|
||||
## Contributing
|
||||
|
||||
To contribute to this site, contact **sneak@sneak.berlin** for git repository access.
|
||||
To contribute to this site, contact **sneak@sneak.berlin** for git repository
|
||||
access.
|
||||
|
||||
## Technical Details
|
||||
|
||||
This is a static site built with Hugo. The site is deployed automatically via GitHub Actions.
|
||||
This is a static site built with Hugo. The site is deployed automatically via
|
||||
GitHub Actions.
|
||||
|
||||
### Local Development
|
||||
|
||||
@@ -35,6 +38,32 @@ hugo
|
||||
|
||||
Output will be in the `public/` directory.
|
||||
|
||||
## Entrypoints
|
||||
|
||||
This repository adheres to the
|
||||
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
||||
standard: normalized scripts in `script/` are the entrypoints for the
|
||||
development workflow, and the Makefile targets are thin shims that call them. We
|
||||
provide:
|
||||
|
||||
- `script/bootstrap` — install all build dependencies (git, make, hugo,
|
||||
node/npm) idempotently
|
||||
- `script/setup` — prepare a fresh clone: run `script/bootstrap` and install the
|
||||
git pre-commit hook
|
||||
- `script/test` — the correctness check: a clean `hugo --minify` production
|
||||
build
|
||||
- `script/lint` — a clean build that surfaces broken links and path collisions
|
||||
- `script/fmt` — format the repo's own top-level markdown docs with prettier
|
||||
- `script/fmt-check` — check that formatting (read-only)
|
||||
- `script/check` — run `script/fmt-check` then `script/test`; modifies nothing
|
||||
- `script/docker` — build the Docker image tagged with the project name
|
||||
- `script/cibuild` — the CI build (`docker build .`); the Dockerfile runs
|
||||
`make check`
|
||||
- `script/install-precommit` — install the git pre-commit hook that runs
|
||||
`script/check`
|
||||
|
||||
A convenience `make serve` target runs `hugo server` for local preview.
|
||||
|
||||
## License
|
||||
|
||||
Content is provided as-is for community use.
|
||||
|
||||
Reference in New Issue
Block a user