Merge branch '4.7.0' of https://github.com/wazuh/wazuh-splunk into me…

…rge-4.7.0-into-master

CHANGELOG.md

@@ -18,6 +18,11 @@ All notable changes to the Wazuh App for Splunk project will be documented in th
 - Added support for Wazuh 4.6.0.
 - Added Files and Registries limits sections in configurations [#1395](https://github.com/wazuh/wazuh-splunk/pull/1395)
 
+## Wazuh v4.5.2 - Splunk Enterprise v8.1.[1-10], v8.2.x - Revision 4503
+
+### Added
+- Added support for Wazuh 4.5.2.
+
 ## Wazuh v4.5.1 - Splunk Enterprise v8.1.[1-10], v8.2.x - Revision 4502
 
 ### Added

RELEASING.md

@@ -0,0 +1,241 @@
+## Releasing
+
+## Runbook
+
+### Overview
+
+### Release Phase 1 - Preparation
+
+#### Files
+
+The following files must be updated:
+
+- `package.json`: Defines the package manifest. It contains the following properties:
+  - `version`: Plugin version. Schema: `{major}.{minor}.{patch}`. Example: 4.4.5
+  - `revision`: Plugin revision. Schema: number with 2 digits. This value is reset for each version to `01` and increament for following revisions.
+  - `splunk`: version of the plugin platform.
+- `SplunkAppForWazuh/appserver/static/js/services/app-version/appVersionService.js`: Defines the plugin metadata. It contains the following properties:
+  - `version`: plugin version.
+  - `revision`: plugin revision.
+- `SplunkAppForWazuh/default/app.conf`: Defines the plugin manifest. It contains the:
+  - `launcher.version`: plugin version.
+  - `install.build`: plugin revision.
+- `SplunkAppForWazuh/default/package.conf`: Defines the another plugin manifest. It contains the `splunk.version` property.
+- `CHANGELOG.md`: Changelog of the new release.
+- `SplunkAppForWazuh/bin/api_info/endpoints.json`: Data related to endpoints and extracted from server's API
+- `SplunkAppForWazuh/bin/api_info/security-actions.json`: Data related to security actions of extracted from server's API
+
+To bump the version, see [# Bump](#Bump)
+
+#### Create tags
+
+After the base branches have set the expected [# Files](#files), we must create the tags.
+
+The tag name follows the pattern:
+- final release tag: `v{version}-{platform version}`. Example: `v4.4.5-8.1`.
+- non-final release tag: `v{version}-{platform version}{suffix}`. Example: `v4.4.5-8.1-pre-alpha1`, `v4.4.5-8.1-alpha1`, `v4.4.5-8.1-rc1`.
+
+> See the [script instructions](#create-tags---script) that reduces this job.
+
+#### Create tags - Manually
+
+Steps:
+
+1. Switch and update the base branch
+
+```
+git checkout <base_branch>
+git pull
+```
+
+2. Review if the version, revision and platform values are defined to the target release in the [#Files](#files), if not accomodate them (creating a new commit).
+
+3. Create the tag
+
+```
+git tag {tag} -a -m "Wazuh {version} for {platform} {platform version}"
+```
+
+> replace the placeholders:
+>
+> - `{tag}`: tag name. Use this schema: `v{version}-{platform version}`. We add suffixes for release candidates or alpha versions:
+>   - pre-alpha: `-pre-alpha{number}`. Example: `-pre-alpha1`.
+>   - release candidates: `-rc{number}`. Example: `-rc1`.
+> - `{version}`: plugin version
+> - `{platform}`: platform name. One of `OpenSearch` or `Kibana`
+> - `{platform version}`: platform version.
+
+4. Push the tag
+
+```
+git push origin {tag}
+```
+
+> replace the placeholder:
+
+- `{tag}`: tag name
+
+#### Create tags - Script
+
+The process to create all the required tags can be run through a script ( `scripts/release/tag` ).
+
+For each supported version defined in `scripts/release/tag`
+
+- edit `version`, `revision` and `splunk` in package manifest file: `package.json`
+- run a process to modify the rest of the manifest files.
+- commit
+- create tag
+- push tag
+
+The script can be run through the package script `yarn release:tag` too. This is the prefered method because defines some required parameters.
+
+Steps:
+
+1. Ensure the target versions are defined as the supported versions in `scripts/release/tag` and the others files are updated.
+   Currently there are 2 versions: Splunk 8.1 and 8.2.
+
+2. Bump version/revision/platform version and create the local and remote tag using the package script
+
+```console
+yarn release:tag --revision <bump_revision>
+```
+
+> If the version or the revision is not specified, then it will use the current values from the package manifest file (package.json).
+> You can bump the `version` or `platform-version` too or combine them.
+> :warning: if the `version` is set, the base branches must exist in the remote repository.
+
+```console
+yarn release:tag --version <bump_version>
+yarn release:tag --revision <bump_revision>
+yarn release:tag --version <version> --revision <revision>
+```
+
+Examples:
+
+- Change the plugin version
+
+```
+yarn release:tag --version 4.5.0
+```
+- Change the plugin revision
+
+```
+yarn release:tag --revision 02
+```
+```
+- Change the plugin version and revision
+
+```
+yarn release:tag --version 4.5.0 --revision 02
+```
+For tags that needs a suffix, use the `--tag-suffix <tag-suffix>` flag.
+
+```
+yarn release:tag --tag-suffix <tag-suffix> <options>
+```
+
+Example:
+
+```
+yarn release:tag --tag-suffix -rc2 --revision 02
+```
+
+If you want to get a report of the tags generated and stored locally, use the `--export-tags <file>`.
+
+```
+yarn release:tag --revision <bump_revision> --export-tags <file>
+```
+
+Example:
+
+```
+yarn release:tag --version 4.5.0 --export-tags tags.log
+```
+
+3. Review the new tags were pushed to the remote repository.
+
+### Build packages
+
+## Release Phase 2 - Release testing
+
+### Release Phase 3 - Release Announcement
+
+### Release Phase 4 - Post-Release
+
+### Bump
+
+It means to increment the version number to a new, unique value.
+
+Bumping the version requires to do some changes in the source code of the application. See [# Files](#files).
+
+We have a script (`scripts/release/bump`) to update some of these files:
+
+- package.json
+- opensearch_dashboards.json or kibana.json
+
+This can be run through the `yarn release:bump` package script too. This is the prefered method because defines some required parameters. **The rest of the files should be changed manually.**
+
+> The package script sets some required parameters related to manifest files.
+
+Steps:
+
+1. Switch to new branch from the base branch to bump
+
+```console
+git checkout <base_branch>
+git pull
+git checkout -b <bump_branch>
+```
+
+2. Bump the version/revision/platform version using the package script
+
+```console
+yarn release:bump --version <bump_version>
+```
+
+> You can bump the `revision` or `platform-version` too or combine them.
+
+```console
+yarn release:bump --version <bump_version>
+yarn release:bump --revision <bump_revision>
+yarn release:bump --platform-version <bump_platform_version>
+yarn release:bump --version <version> --revision <revision> --platform-version <bump_platform_version>
+```
+
+Examples:
+
+- Change the plugin version
+
+```
+yarn release:bump --version 4.5.0
+```
+
+- Change the plugin revision
+
+```
+yarn release:bump --revision 02
+```
+
+- Change the platform version
+
+```
+yarn release:bump --platform-version 8.2
+```
+
+- Change the plugin version, revision and platform version
+
+```
+yarn release:bump --version 4.5.0 --revision 02 --platform-version 8.2
+```
+
+3. Apply manually the changes to the rest of files if needed it. See [# Files](#Files).
+
+4. Optional. Commit and push the new branch to the remote repository.
+
+```
+git add .
+git commit -m "bump: Bump version/revision/platform version to <version/revision/platform version>"
+git push origin <branch_name>
+```
+
+A new branch will be created in the remote and will be ready to receive pull requests or use as source to create the tags.

package.json

@@ -37,7 +37,9 @@
     "lint": "make lint",
     "prebuild": "make prebuild",
     "pretty": "make pretty",
-    "test": "mocha tests/manager.js"
+    "test": "mocha tests/manager.js",
+    "release:bump": "node scripts/release/bump --manifest-package package.json",
+    "release:tag": "node scripts/release/tag --manifest-package package.json"
   },
   "version": "4.8.0",
   "revision": "4800",