Skip to content

Commit b37ad5d

Browse files
committed
Merge branch 'feature/github-security-setup' into 'main'
ci: add SECURITY.md, CodeQL analysis, and Dependabot for GitHub See merge request postgres-ai/postgresai!225
2 parents f3c7a01 + df3ff75 commit b37ad5d

3 files changed

Lines changed: 92 additions & 0 deletions

File tree

.github/dependabot.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# NOTE: This repo is mirrored to GitHub where Dependabot runs automatically.
2+
# Dependabot creates PRs on GitHub, which are then synced back to GitLab.
3+
#
4+
# Documentation: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
13+
- package-ecosystem: "pip"
14+
directory: "/reporter"
15+
schedule:
16+
interval: "weekly"
17+
18+
- package-ecosystem: "pip"
19+
directory: "/monitoring_flask_backend"
20+
schedule:
21+
interval: "weekly"
22+
23+
- package-ecosystem: "npm"
24+
directory: "/cli"
25+
schedule:
26+
interval: "weekly"
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# NOTE: This repo is mirrored to GitHub where this workflow runs automatically.
2+
name: "CodeQL"
3+
4+
on:
5+
push:
6+
branches: [main]
7+
pull_request:
8+
branches: [main]
9+
schedule:
10+
- cron: '40 17 * * 5'
11+
12+
jobs:
13+
analyze:
14+
name: Analyze
15+
runs-on: ubuntu-latest
16+
permissions:
17+
actions: read
18+
contents: read
19+
security-events: write
20+
21+
strategy:
22+
fail-fast: false
23+
matrix:
24+
language: ['python', 'javascript']
25+
# CodeQL supports: 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby'
26+
27+
steps:
28+
- name: Checkout repository
29+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
30+
31+
- name: Initialize CodeQL
32+
uses: github/codeql-action/init@820e3160e279568db735cee8ed8f8e77a6da7818 # v3
33+
with:
34+
languages: ${{ matrix.language }}
35+
36+
- name: Autobuild
37+
uses: github/codeql-action/autobuild@820e3160e279568db735cee8ed8f8e77a6da7818 # v3
38+
39+
- name: Perform CodeQL Analysis
40+
uses: github/codeql-action/analyze@820e3160e279568db735cee8ed8f8e77a6da7818 # v3

SECURITY.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security guidelines
2+
3+
## Reporting vulnerabilities
4+
5+
If you discover a security vulnerability in this project, please report it to **security@postgres.ai**. All reports are thoroughly investigated by the project maintainers.
6+
7+
### When should I report a vulnerability?
8+
9+
- You think you have discovered a potential security vulnerability in this project or related components.
10+
- You are unsure how a vulnerability affects this project.
11+
- You think you discovered a vulnerability in another project that this project depends on.
12+
- You want to report any other security risk that could potentially harm users.
13+
14+
### When should I NOT report a vulnerability?
15+
16+
- Your issue is not security related.
17+
18+
## Security Vulnerability Response
19+
20+
Each report is acknowledged and analyzed by the project maintainers and the security team within 3 working days.
21+
22+
The reporter will be kept updated at every stage of the issue's analysis and resolution (triage → fix → release).
23+
24+
## Public Disclosure Timing
25+
26+
A public disclosure date is negotiated by the maintainers (security@postgres.ai) and the bug submitter. We prefer to fully disclose the bug as soon as possible once user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. We expect the timeframe between a report and public disclosure to typically be in the order of 7 days.

0 commit comments

Comments
 (0)