feat: include example configuration in the RPM package

farzadghanei · May 12, 2024 · cdfed9a · cdfed9a
1 parent da606a6
commit cdfed9a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/build/package/chkok.spec b/build/package/chkok.spec
@@ -1,7 +1,7 @@
 Name: chkok
 Version: 0.3.0
 Release: 1%{?dist}
-Summary: checks files and sockets attributes
+Summary: checks attributes of files and sockets
 
 License: MIT
 URL: https://github.com/farzadghanei/chkok
@@ -33,6 +33,7 @@ rm -rf $RPM_BUILD_ROOT
 %make_install
 mkdir -p $RPM_BUILD_ROOT/usr/share/man/man1
 cp -a docs/man/chkok.1 $RPM_BUILD_ROOT/usr/share/man/man1/%{name}.1
+cp -a examples/config.yaml example-config.yaml
 
 
 %clean
@@ -41,7 +42,7 @@ rm -rf $RPM_BUILD_ROOT
 
 %files
 %license LICENSE
-%doc README.rst
+%doc README.rst example-config.yaml
 %{_bindir}/%{name}
 %{_mandir}/man1/%{name}*
 

diff --git a/examples/config.yaml b/examples/config.yaml
@@ -1,5 +1,7 @@
 ---
+# configurations for chkok
 
+# define how the checks should run
 runners:
   default:
     timeout: 5m
@@ -24,7 +26,8 @@ runners:
     #   "X-Required-Header": "required-value"
     #   "X-Required-Header2": ""  # header existence is required, not value
 
-
+# define the checks to be run. Each check suite
+# is a logical group of checks that should run sequentially.
 check_suites:
   etc:
     - type: dir