Skip to content

Commit 7fd7d34

Browse files
ParthaIcbruno10
andauthored
Update plugin to latest standards for v0.1.0 release (#11)
Co-authored-by: Cody Bruno <[email protected]>
1 parent 2816be9 commit 7fd7d34

File tree

17 files changed

+852
-1613
lines changed

17 files changed

+852
-1613
lines changed

.github/workflows/registry-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77

88
jobs:
99
registry_publish_workflow_ghcr:
10-
uses: turbot/steampipe-workflows/.github/workflows/registry-publish-ghcr.yml@extend-ghcr-publish
10+
uses: turbot/steampipe-workflows/.github/workflows/registry-publish-ghcr.yml@main
1111
secrets: inherit
1212
with:
1313
releaseTimeout: 60m

README.md

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[GitHub](https://www.github.com/) is a provider of Internet hosting for software development and version control using Git. It offers the distributed version control and source code management (SCM) functionality of Git, plus its own features.
66

7-
The [GitHub Plugin for Tailpipe](https://hub.tailpipe.io/plugins/turbot/github) allows you to collect and query GitHub logs using SQL to track activity, monitor trends, detect anomalies, and more!
7+
The [GitHub Plugin for Tailpipe](https://hub.tailpipe.io/plugins/turbot/github) allows you to collect and query GitHub audit logs using SQL to track activity, monitor trends, detect anomalies, and more!
88

99
- **[Get started →](https://hub.tailpipe.io/plugins/turbot/github)**
1010
- Documentation: [Table definitions & examples](https://hub.tailpipe.io/plugins/turbot/github/tables)
@@ -43,7 +43,8 @@ vi ~/.tailpipe/config/github.tpc
4343
```hcl
4444
partition "github_audit_log" "my_logs" {
4545
source "file" {
46-
paths = ["/Users/myuser/github_logs"]
46+
paths = ["/Users/myuser/github_audit_logs"]
47+
file_layout = "%{DATA}.json.gz"
4748
}
4849
}
4950
```
@@ -65,44 +66,34 @@ Run a query:
6566
```sql
6667
select
6768
action,
68-
count(*) as event_count
69+
count(*) as action_count
6970
from
7071
github_audit_log
7172
group by
7273
action
7374
order by
74-
event_count desc;
75+
action_count desc;
7576
```
7677

7778
```sh
78-
+---------------------------------------+-------------+
79-
| action | event_count |
80-
+---------------------------------------+-------------+
81-
| pull_request.create | 7913 |
82-
| pull_request.merge | 5754 |
83-
| issue_comment.update | 4292 |
84-
| protected_branch.policy_override | 3304 |
85-
| packages.package_version_published | 2983 |
86-
| pull_request_review.submit | 2674 |
87-
| pull_request.close | 2200 |
88-
| pull_request_review_comment.create | 1875 |
89-
| pull_request.create_review_request | 1793 |
90-
| repository_vulnerability_alert.create | 1644 |
91-
+---------------------------------------+-------------+
79+
+----------------------------------------+--------------+
80+
| action | action_count |
81+
+----------------------------------------+--------------+
82+
| pull_request.create | 9894 |
83+
| pull_request.merge | 7440 |
84+
| issue_comment.update | 5832 |
85+
| packages.package_version_published | 4990 |
86+
| protected_branch.policy_override | 4012 |
87+
| pull_request_review.submit | 3672 |
88+
| pull_request_review_comment.create | 2516 |
89+
| pull_request.close | 2462 |
90+
| pull_request.create_review_request | 2438 |
91+
| repository_vulnerability_alert.create | 1972 |
92+
| repository_vulnerability_alert.resolve | 1486 |
93+
| repo.change_merge_setting | 892 |
94+
+----------------------------------------+--------------+
9295
```
9396

94-
## Detections as Code with Powerpipe
95-
96-
Pre-built dashboards and detections for the GitHub plugin are available in [Powerpipe](https://powerpipe.io) mods, helping you monitor and analyze activity across your GitHub accounts.
97-
98-
For example, the [GitHub Audit Logs Detections mod](https://hub.powerpipe.io/mods/turbot/tailpipe-mod-github-cloudtrail-log-detections) scans your CloudTrail logs for anomalies, such as an S3 bucket being made public or a change in your VPC network infrastructure.
99-
100-
Dashboards and detections are [open source](https://github.com/topics/tailpipe-mod), allowing easy customization and collaboration.
101-
102-
To get started, choose a mod from the [Powerpipe Hub](https://hub.powerpipe.io/?engines=tailpipe&q=github).
103-
104-
![image](docs/images/github_audit_log_mitre_dashboard.png)
105-
10697
## Developing
10798

10899
Prerequisites:

0 commit comments

Comments
 (0)