From 018e90f3d218066c0b491b021bca2003d21ccf54 Mon Sep 17 00:00:00 2001 From: Minionguyjpro Date: Sun, 31 Dec 2023 13:12:16 +0100 Subject: [PATCH] Create example.md --- docs/example.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/example.md diff --git a/docs/example.md b/docs/example.md new file mode 100644 index 0000000..bf1d22a --- /dev/null +++ b/docs/example.md @@ -0,0 +1,19 @@ +# Example Usage +Here is an example of a workflow that you can use as base for your workflow (change it to your own needs!): +```yml +name: Build Installer +on: push +jobs: + build: + name: Build the Inno Setup Installer + runs-on: windows-latest + steps: + - uses: actions/checkout@v4 + + - name: Compile .ISS to .EXE Installer + uses: Minionguyjpro/Inno-Setup-Action@v1.2.2 + with: + path: src/setup.iss + options: /O+ +``` +In this example, we run the ``actions/checkout`` action **before** the ``Minionguyjpro/Inno-Setup-Action`` action! This is **required**. After that, we run our action as you should (unless you need to add anything in between the actions, but most probably shouldn't). Then we specify the path starting from our root, so the script is the ``setup.iss`` file in the ``src`` directory if you look at the root of the GitHub repository. Then we specify the ``/O+`` parameter, in order to force override the output to show, no matter what the script has specified.