pre-commit: handle *.md files with mdformat + apply it (#12)

* pre-commit: handle *.md files with mdformat + apply it Also exclude .md files from trailing-whitespace hook and update hooks via `pre-commit autoupdate`. * Fix !NOTE syntax
michalfita · Dec 30, 2023 · a42d6e2 · a42d6e2
1 parent a6d3dd5
commit a42d6e2
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 45 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,6 +14,7 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
+        exclude: .*\.md
   - repo: https://github.com/lovesegfault/beautysh
     rev: v6.2.1
     hooks:
@@ -31,14 +32,21 @@ repos:
     hooks:
       - id: go-fmt
      #- id: golangci-lint
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.17
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          # gfm = github flavoured markdown
+          - mdformat-gfm
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.6
     hooks:
       - id: codespell
         exclude: go\.sum$
         args: ["-w"]
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.27.0
+    rev: 0.27.3
     hooks:
       - id: check-github-workflows
       - id: check-dependabot

diff --git a/README.md b/README.md
@@ -1,48 +1,44 @@
 # Packer Plugin: Cross
 
-> [!IMPORTANT]
+> \[!IMPORTANT\]
 > This is hard fork from [packer-builder-arm](https://github.com/mkaczanowski/packer-builder-arm) intended to break backward compatibility at some point to fix some problems and let easier support of other cross-platforms than ARM.
 
 [![Build Status][github-badge]][github]
 [![GoDoc][godoc-badge]][godoc]
 [![GoReportCard][report-badge]][report]
 
-[github-badge]:https://img.shields.io/github/actions/workflow/status/michalfita/packer-plugin-cross/docker.yml?branch=master
-[github]: https://github.com/michalfita/packer-plugin-cross/actions
-[godoc-badge]: https://godoc.org/github.com/michalfita/packer-plugin-cross?status.svg
-[godoc]: https://godoc.org/github.com/michalfita/packer-plugin-cross
-[report-badge]: https://goreportcard.com/badge/github.com/michalfita/packer-plugin-cross
-[report]: https://goreportcard.com/report/github.com/michalfita/packer-plugin-cross
-
 This plugin allows you to build or extend cross-platform system image. It operates in three modes:
-* new - creates empty disk image and populates the `rootfs` on it
-* reuse - uses already existing image as the base
-* resize - uses already existing image but resize the given partition (i.e. `root`)
+
+- new - creates empty disk image and populates the `rootfs` on it
+- reuse - uses already existing image as the base
+- resize - uses already existing image but resize the given partition (i.e. `root`)
 
 Plugin mimics standard image creation process, such as:
-* building base empty image (`dd`)
-* partitioning (`sgdisk` / `sfdisk`)
-* filesystem creation (`mkfs.type`)
-* partition mapping (`losetup`)
-* filesystem mount (`mount`)
-* populate `rootfs` (`tar`/`unzip`/`xz` etc.)
-* setup `qemu` + `chroot`
-* customize installation within `chroot`
+
+- building base empty image (`dd`)
+- partitioning (`sgdisk` / `sfdisk`)
+- filesystem creation (`mkfs.type`)
+- partition mapping (`losetup`)
+- filesystem mount (`mount`)
+- populate `rootfs` (`tar`/`unzip`/`xz` etc.)
+- setup `qemu` + `chroot`
+- customize installation within `chroot`
 
 The virtualization works via [`binfmt_misc`](https://en.wikipedia.org/wiki/Binfmt_misc) kernel feature and `qemu`.
 
 Since the setup varies a lot for different hardware types, the example configuration is available per "board". Currently the following boards are supported (feel free to add more):
-* bananapi-r1 (Archlinux ARM)
-* beaglebone-black (Archlinux ARM, Debian)
-* jetson-nano (Ubuntu)
-* odroid-u3 (Archlinux ARM)
-* odroid-xu4 (Archlinux ARM, Ubuntu)
-* parallella (Ubuntu)
-* raspberry-pi (Archlinux ARM, Raspbian)
-* raspberry-pi-3 (Archlinux ARM (armv8))
-* raspberry-pi-4 (Archlinux ARM (armv7), Ubuntu 20.04 LTS))
-* wandboard (Archlinux ARM)
-* armv7 generic (Alpine, Archlinux ARM)
+
+- bananapi-r1 (Archlinux ARM)
+- beaglebone-black (Archlinux ARM, Debian)
+- jetson-nano (Ubuntu)
+- odroid-u3 (Archlinux ARM)
+- odroid-xu4 (Archlinux ARM, Ubuntu)
+- parallella (Ubuntu)
+- raspberry-pi (Archlinux ARM, Raspbian)
+- raspberry-pi-3 (Archlinux ARM (armv8))
+- raspberry-pi-4 (Archlinux ARM (armv7), Ubuntu 20.04 LTS))
+- wandboard (Archlinux ARM)
+- armv7 generic (Alpine, Archlinux ARM)
 
 # Quick start
 
@@ -61,52 +57,64 @@ This method is primarily for macOS users where is no native way to use `qemu-use
 
 The container is a multi-arch container (Linux/amd64 or Linux/arm64), that can be used on Intel (x86_64) or Apple M1 (arm64) Macs and also on Linux machines running Linux (x86_64 or aarch64) kernels.
 
-> ![NOTE]
+> \[!NOTE\]
 > On Macs: Don't run `go build .` (that produces a **Darwin** binary) and then run below `docker run ...` commands from the same folder to avoid the error `error initializing builder 'arm': fork/exec /build/packer-plugin-cross: exec format error` (**Linux** packer process within docker fails to load the outside container compiled `packer-plugin-cross` binary due to being a **Darwin** binary). Delete any local binary via `rm -r packer-*` to solely use the binary already included and provided by the container.
 
 ### Usage via container from Docker Hub:
 
 Pull the latest version of the container to ensure the next commands are not using an old cached version of the container:
+
 ```
 docker pull ghcr.io/michalfita/packer-plugin-cross:latest
 ```
 
 Build a board:
+
 ```
 docker run --rm --privileged -v /dev:/dev -v ${PWD}:/build ghcr.io/michalfita/packer-plugin-cross:latest build boards/raspberry-pi/raspbian.json
 ```
+
 Build a board with more system packages (e.g. `bmap-tools`, `zstd`) can be added via the parameter `-extra-system-packages=...`:
+
 ```
 docker run --rm --privileged -v /dev:/dev -v ${PWD}:/build ghcr.io/michalfita/packer-plugin-cross:latest build boards/raspberry-pi/raspbian.json -extra-system-packages=bmap-tools,zstd
 ```
 
-> [!TIP]
+> \[!TIP\]
 > In above commands **`latest`** can also be replaced via e.g. **`1.0.3`** to get a specific container version.
 
 ### Usage via local container build (supports amd64/aarch64 hosts):
+
 Build the container locally:
+
 ```
 docker build -t packer-plugin-cross -f docker/Dockerfile .
 ```
+
 Run packer via the local built container:
+
 ```
 docker run --rm --privileged -v /dev:/dev -v ${PWD}:/build packer-plugin-cross build boards/raspberry-pi/raspbian.json
 ```
 
 # Dependencies
-* `sfdisk / sgdisk`
-* `e2fsprogs`
-* `parted` (resize mode)
-* `resize2fs` (resize mode)
-* `qemu-img` (resize mode)
+
+- `sfdisk / sgdisk`
+- `e2fsprogs`
+- `parted` (resize mode)
+- `resize2fs` (resize mode)
+- `qemu-img` (resize mode)
 
 # Configuration
+
 Configuration is split into 3 parts:
-* remote file config
-* image config
-* qemu config
+
+- remote file config
+- image config
+- qemu config
 
 ## Remote file
+
 Describes the remote file that is going to be used as base image or rootfs archive (depending on `image_build_method`)
 
 ```
@@ -124,6 +132,7 @@ The `file_unarchive_cmd` is optional and should be used if the [Archiver package
 Raw images format (`.img` or `.iso`) can be used by defining the `file_target_extension` appropriately.
 
 ## Image config
+
 The base image description (size, partitions, mountpoints etc).
 
 ```
@@ -146,6 +155,7 @@ The base image description (size, partitions, mountpoints etc).
 The plugin doesn't try to detect the image partitions because that varies a lot. Instead it solely depend on `image_partitions` specification, so you should set that even if you reuse the image (`method` = reuse).
 
 ## Qemu config
+
 Anything qemu related:
 
 ```
@@ -154,11 +164,14 @@ Anything qemu related:
 ```
 
 The arm instruction set (default=`armv7l` for `qemu-arm-static`) to be emulated can be defined via the `QEMU_CPU` variable. To switch to `armv6l` (check with `uname -m` as provision command) run packer e.g. via:
-* `QEMU_CPU=arm1176 packer build ...`
-* `docker run -e QEMU_CPU=arm1176 ...`
+
+- `QEMU_CPU=arm1176 packer build ...`
+- `docker run -e QEMU_CPU=arm1176 ...`
 
 # Chroot provisioner
+
 To execute command within chroot environment you should use chroot communicator:
+
 ```
 "provisioners": [
  {
@@ -170,10 +183,13 @@ To execute command within chroot environment you should use chroot communicator:
  }
 ]
 ```
+
 This plugin doesn't resize partitions on the base image. However, you can easily expand partition size at the boot time with a `systemd` service. [Here](./boards/raspberry-pi/archlinuxarm.json) you can find real-life example, where a raspberry pi root-fs partition expands to all available space on SD card.
 
 # Flashing
+
 To dump image on device you can use [custom postprocessor](https://github.com/mkaczanowski/packer-post-processor-flasher) (really wrapper around `dd` with some sanity checks):
+
 ```
 "post-processors": [
  {
@@ -186,19 +202,24 @@ To dump image on device you can use [custom postprocessor](https://github.com/mk
 ```
 
 # Other
+
 ## Generating rootfs archive
+
 While image (`.img`) format is useful for most cases, you might want to use
 rootfs for other purposes (ex. export to docker). This is how you can generate
 rootfs archive instead of image:
+
 ```
 "image_path": "odroid-xu4.img" # generates image
 "image_path": "odroid-xu4.img.tar.gz" # generates rootfs archive
 ```
 
 ## Resizing image
+
 Currently resizing is only limited to expanding single `ext{2,3,4}` partition with `resize2fs`. This is often requested feature where already built image is given and we need to expand the main partition to accommodate changes made in provisioner step (i.e. installing packages).
 
 To resize a partition you need to set `image_build_method` to `resize` mode and set selected partition size to `0`, for example:
+
 ```
 "builders": [
   {
@@ -226,7 +247,9 @@ Complete examples:
 - [`boards/beaglebone-black/ubuntu.pkr.hcl`](./boards/beaglebone-black/ubuntu.pkr.hcl)
 
 ## Docker
+
 With `artifice` plugin you can pass rootfs archive to docker plugins
+
 ```
 "post-processors": [
     [{
@@ -243,10 +266,13 @@ With `artifice` plugin you can pass rootfs archive to docker plugins
 ```
 
 ## How is this plugin different from `solo-io/packer-plugin-cross-image`
+
 https://github.com/hashicorp/packer/pull/8462
 
 # Examples
+
 For more examples please see:
+
 ```
 tree boards/
 ```
@@ -261,22 +287,35 @@ tree scripts/
 A big resource for packer provisions scripts is the [GitHub Actions runner images](https://github.com/actions/runner-images) repository.
 
 # Troubleshooting
+
 Many of the reported issues are platform/OS specific. If you happen to have
 problems, the first question you should ask yourself is:
+
 > Is my setup faulty? or is there an actual issue?
 
 To answer that question, I'd recommend reproducing the error on the VM, for
 instance:
+
 ```
 cd packer-plugin-cross
 vagrant up
 vagrant provision
 ```
-> [!NOTE]
+
+> \[!NOTE\]
 > For this the `disksize` plugin is needed if not already installed:
+>
 > ```sh
 > vagrant plugin install vagrant-disksize
-> ``````
+> ```
 
 # Demo
+
 [![asciicast](https://asciinema.org/a/7ad1nm2Q7DRFVlHpqAknPolNo.svg)](https://asciinema.org/a/7ad1nm2Q7DRFVlHpqAknPolNo)
+
+[github]: https://github.com/michalfita/packer-plugin-cross/actions
+[github-badge]: https://img.shields.io/github/actions/workflow/status/michalfita/packer-plugin-cross/docker.yml?branch=master
+[godoc]: https://godoc.org/github.com/michalfita/packer-plugin-cross
+[godoc-badge]: https://godoc.org/github.com/michalfita/packer-plugin-cross?status.svg
+[report]: https://goreportcard.com/report/github.com/michalfita/packer-plugin-cross
+[report-badge]: https://goreportcard.com/badge/github.com/michalfita/packer-plugin-cross