From 7abc4df2aea3a0a56730d34921381cf233e42db6 Mon Sep 17 00:00:00 2001 From: Simon de Vlieger Date: Tue, 23 Apr 2024 07:29:31 +0200 Subject: [PATCH 1/4] readme: reorder Moves some things around to move usage up and development down a bit. Signed-off-by: Simon de Vlieger --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 85adc55c..ab8bf672 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ **THIS IS A PROOF OF CONCEPT REPOSITORY** +We are still sketching out this potential approach to generating manifests and +thus this repository is very much a work in progress. + This is the "Omnifest Toolkit", also known as `otk`. A YAML transpiler to take omnifest inputs and translate them into [osbuild](https://osbuild.org) manifests. -We are still sketching out this potential approach to generating manifests and -thus this repository is very much a work in progress. - ## Usage ``` @@ -21,7 +21,18 @@ thus this repository is very much a work in progress. # See `otk --help` for help. ``` -## Pre Commit Checks +## Documentation + +There is documentation about the [format](./doc/format.md) and the available +[directives](./doc/directives.md). + +## Examples + +Read the [examples](./example) to see what omnifests look like. + +## Development + +### Pre Commit Checks To check your code for basic problems, we use https://pre-commit.com The tool itself will be installed by the `pip` command above (see [Usage](#Usage)) after that you @@ -38,17 +49,7 @@ repository including all the tests with: make test ``` - -## Documentation - -There is documentation about the [format](./doc/format.md) and the available -[directives](./doc/directives.md). - -## Examples - -Read the [examples](./example) to see what omnifests look like. - -## Tests +### Tests To run the tests, you have to install the package (see [Usage](#Usage)) and call `pytest` From d62a9a8693faa7e994517c13e7e469fac139a186 Mon Sep 17 00:00:00 2001 From: Simon de Vlieger Date: Tue, 23 Apr 2024 07:31:01 +0200 Subject: [PATCH 2/4] readme: project blurb Include our default project information blurb in the README. Signed-off-by: Simon de Vlieger --- .spellcheck-en-custom.txt | 2 ++ README.md | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt index 5d1e861d..01f289e3 100644 --- a/.spellcheck-en-custom.txt +++ b/.spellcheck-en-custom.txt @@ -15,3 +15,5 @@ osbuild preprocessing transpiler Pre +fedoraproject +Changelog diff --git a/README.md b/README.md index ab8bf672..a7efe668 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,11 @@ A list of current problems or things that just aren't that nice yet: - Omnifests are valid YAML, no preprocessing is done on them. - No introspection of the tree. - No language-specific quirks in the directives (e.g. `eval`). + +## Project + + * **Website**: https://www.osbuild.org + * **Bug Tracker**: https://github.com/osbuild/otk/issues + * **Matrix**: #image-builder on [fedoraproject.org](https://matrix.to/#/#image-builder:fedoraproject.org) + * **Mailing List**: image-builder@redhat.com + * **Changelog**: https://github.com/osbuild/otk/releases From 245b9257d644956bd5deb2cf3bcc23de0493a7a8 Mon Sep 17 00:00:00 2001 From: Simon de Vlieger Date: Tue, 23 Apr 2024 07:33:04 +0200 Subject: [PATCH 3/4] readme: document `pre-commit` Moves the `test` to `lint`, moves the link into a prettier one. Signed-off-by: Simon de Vlieger --- .spellcheck-en-custom.txt | 1 + README.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt index 01f289e3..95cbdf3d 100644 --- a/.spellcheck-en-custom.txt +++ b/.spellcheck-en-custom.txt @@ -15,5 +15,6 @@ osbuild preprocessing transpiler Pre +pre fedoraproject Changelog diff --git a/README.md b/README.md index a7efe668..cc78cfad 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Read the [examples](./example) to see what omnifests look like. ### Pre Commit Checks -To check your code for basic problems, we use https://pre-commit.com +To check our code for basic problems we use [pre-commit](https://pre-commit.com) The tool itself will be installed by the `pip` command above (see [Usage](#Usage)) after that you should run @@ -42,11 +42,11 @@ should run pre-commit install ``` -After that the system automatically checks upon commit, or you can run it against the whole +After this the system automatically checks upon commit, or you can run it against the whole repository including all the tests with: ``` -make test +make lint ``` ### Tests From 60b9d93e732dae7ca259700acb1e18875bd612d0 Mon Sep 17 00:00:00 2001 From: Simon de Vlieger Date: Tue, 23 Apr 2024 09:52:01 +0200 Subject: [PATCH 4/4] readme: pre-commit test Use `make test` which includes `pre-commit` to conform with the text above it. Signed-off-by: Simon de Vlieger --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc78cfad..95343ece 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ After this the system automatically checks upon commit, or you can run it agains repository including all the tests with: ``` -make lint +make test ``` ### Tests