wayshot icon indicating copy to clipboard operation
wayshot copied to clipboard

KISS build docs

Open murlakatamenka opened this issue 1 year ago • 5 comments
trafficstars

Fixes #101

  • makes iterations while working on wayshot faster, thus better for devs and contributors.
  • makes make more explicit about what it does
  • fixes a minor issue of docs/*.7.gz not being cleaned

murlakatamenka avatar Mar 12 '24 22:03 murlakatamenka

Hi @murlakatamenka. This needs to be rebased onto freeze-feat-andreas branch

Shinyzenith avatar Mar 13 '24 16:03 Shinyzenith

Make check earlier used to ensure that scdoc could compile the docs too. We use it in CI.

if that can be implemented here then we can go ahead with a merge.

Shinyzenith avatar Mar 14 '24 12:03 Shinyzenith

Make check earlier used to ensure that scdoc could compile the docs too. We use it in CI.

if that can be implemented here then we can go ahead with a merge.

Previously the docs were built into gzipped man pages during cargo build/build.rs:

https://github.com/waycrate/wayshot/blob/8f22e6da9005f7495d38d89f2430a2649c4499ef/.github/workflows/build.yml#L19

And also checked in a separate job:

https://github.com/waycrate/wayshot/blob/8f22e6da9005f7495d38d89f2430a2649c4499ef/.github/workflows/build.yml#L32-L43


Now that build.rs is gone, only documentation job checks if scdoc can process the files, this should be enough for CI. Gzipping the output can be considered infallible.

Ideally there should be a job or workflow that gets triggered only if those *.scd files change, because such changes are rare compared to modifying the sources.


So far I'm done with the changes, feel free to review.

murlakatamenka avatar Mar 14 '24 23:03 murlakatamenka

Things look great. Thanks for the PR!

Shinyzenith avatar Mar 23 '24 16:03 Shinyzenith

I just realized something I forgot to ask. The code you've written is POSIX compliant right? I would rather keep away from bash extensions.

Shinyzenith avatar Mar 23 '24 16:03 Shinyzenith