Skip to content

Commit f7be3f6

Browse files
committed
chore: added docs in README and CLI. Added changelog. Updated project version.
1 parent 774a778 commit f7be3f6

4 files changed

Lines changed: 47 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.40.0] - 2026-04-06
9+
### Added
10+
- Parser validation methods
11+
- `trigger_github_checks()` - Trigger GitHub checks for a parser against an associated pull request
12+
- `get_analysis_report()` - Retrieve a completed parser analysis report
13+
- CLI support for parser validation commands
14+
- `secops log-type trigger-checks` - Trigger parser validation checks for a PR
15+
- `secops log-type get-analysis-report` - Get details of a specific analysis report
16+
817
## [0.39.0] - 2026-04-02
918
### Updated
1019
- Refactored Chronicle modules to use centralized `chronicle_request` and `chronicle_paginated_request` helper functions for improved code consistency and maintainability

CLI.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -696,6 +696,22 @@ Error messages are detailed and help identify issues:
696696
- Size limit violations
697697
- API-specific errors
698698

699+
#### Parser Validation
700+
701+
You can trigger and retrieve analysis reports for parsers associated with GitHub pull requests.
702+
703+
Trigger GitHub checks for a parser:
704+
705+
```bash
706+
secops log-type trigger-checks --log-type "WINDOWS_AD" --associated-pr "owner/repo/pull/123"
707+
```
708+
709+
Get a parser analysis report:
710+
711+
```bash
712+
secops log-type get-analysis-report --log-type "WINDOWS_AD" --parser-id "pa_12345" --report-id "report_12345"
713+
```
714+
699715
### Parser Extension Management
700716

701717
Parser extensions provide a flexible way to extend the capabilities of existing default (or custom) parsers without replacing them.

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1898,6 +1898,27 @@ This workflow is useful for:
18981898
- Re-processing logs with updated parsers
18991899
- Debugging parsing issues
19001900

1901+
### Parser Validation
1902+
1903+
Trigger and retrieve analysis reports for parsers associated with GitHub pull requests:
1904+
1905+
```python
1906+
# Trigger GitHub checks for a parser against a PR
1907+
response = chronicle.trigger_github_checks(
1908+
associated_pr="owner/repo/pull/123",
1909+
log_type="WINDOWS_AD"
1910+
)
1911+
print(f"Triggered checks: {response}")
1912+
1913+
# Retrieve the analysis report
1914+
report = chronicle.get_analysis_report(
1915+
log_type="WINDOWS_AD",
1916+
parser_id="pa_1234567890",
1917+
report_id="report_0987654321"
1918+
)
1919+
print(f"Analysis report: {report}")
1920+
```
1921+
19011922
## Parser Extension
19021923

19031924
Parser extensions provide a flexible way to extend the capabilities of existing default (or custom) parsers without replacing them. The extensions let you customize the parser pipeline by adding new parsing logic, extracting and transforming fields, and updating or removing UDM field mappings.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "secops"
7-
version = "0.39.0"
7+
version = "0.40.0"
88
description = "Python SDK for wrapping the Google SecOps API for common use cases"
99
readme = "README.md"
1010
requires-python = ">=3.10"

0 commit comments

Comments
 (0)