Skip to content

Commit

Permalink
Removes version parameter from build script
Browse files Browse the repository at this point in the history
Updates documentation to remove the version parameter from the build script usage instructions. Adds a commit SHA parameter for better tracking of builds.
  • Loading branch information
guidomodarelli committed Feb 26, 2025
1 parent 2d53fc4 commit abbc459
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions source/development/packaging/generate-dashboard-package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,10 @@ Using the script

Run the ``build-packages.sh`` script in the ``dev-tools/build-packages/`` folder of the repository. The script requires the following parameters:

- ``-c``, ``--commit-sha``: Set the commit sha of this build.
- ``-a``, ``--app``: Indicate the path to ``wazuh-package.zip``.
- ``-b``, ``--base``: Indicate the path to ``dashboard-package.zip``.
- ``-s``, ``--security``: Indicate the path to ``security-package.zip``.
- ``-v``, ``--version``: Set the version for this build.
- ``--all-platforms``: Build the packages for all platforms.
- ``--deb``: Build a deb package.
- ``--rpm``: Build an rpm package.
Expand All @@ -182,7 +182,7 @@ Run the ``build-packages.sh`` script in the ``dev-tools/build-packages/`` folder
.. code:: console
$ cd ../wazuh-dashboard/dev-tools/build-packages/
$ ./build-packages.sh -v <VERSION> -r <REVISION> --<DISTRIBUTION> -a file:///<PATH_TO_wazuh-package.zip> -s file:///<PATH_TO_security-package.zip> -b file:///<PATH_TO_dashboard-package.zip>
$ ./build-packages.sh -r <REVISION> --<DISTRIBUTION> -a file:///<PATH_TO_wazuh-package.zip> -s file:///<PATH_TO_security-package.zip> -b file:///<PATH_TO_dashboard-package.zip>
Where ``--<DISTRIBUTION>`` is either ``--deb``, ``--rpm``, ``--tar``, or ``--all-platforms``.

Expand All @@ -199,7 +199,7 @@ Example:
.. code:: console
$ cd ../wazuh-dashboard/dev-tools/build-packages/
$ ./build-packages.sh -v v|WAZUH_CURRENT| -r 1 --deb -a file:///packages/wazuh-package.zip -s file:///packages/security-package.zip -b file:///packages/dashboard-package.zip
$ ./build-packages.sh -r 1 --deb -a file:///packages/wazuh-package.zip -s file:///packages/security-package.zip -b file:///packages/dashboard-package.zip
The script generates the package in the ``output`` folder of the same directory where it is located.

Expand Down

0 comments on commit abbc459

Please sign in to comment.