Skip to content

Commit 6777022

Browse files
committed
update
1 parent 72466e7 commit 6777022

File tree

4 files changed

+11
-13
lines changed

4 files changed

+11
-13
lines changed

develop-docs/sdk/platform-specifics/python-sdk/backporting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Backporting
33
description: How to backport to an earlier major.
4-
sidebar_order: 20
4+
sidebar_order: 10
55
---
66

77
The last normal 1.x release was [1.45.0](https://github.com/getsentry/sentry-python/releases/tag/1.45.0) in April 2024. Development on 1.x has stopped — we are not backporting any features or bugfixes outside of security fixes.
88

9-
If there is a security issue in the SDK severe enough that it needs a backport to 1.x (see for example [1.45.1](https://github.com/getsentry/sentry-python/releases/tag/1.45.1)):
9+
If there is a security issue in the SDK severe enough (use your judgement) that it needs a backport to 1.x (see for example [1.45.1](https://github.com/getsentry/sentry-python/releases/tag/1.45.1)):
1010

1111
- Checkout the `1.x` branch
1212
- Port the fix into the `1.x` branch

develop-docs/sdk/platform-specifics/python-sdk/ci.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
22
title: CI
3-
description: How our CI files are generated and general caveats.
4-
sidebar_order: 30
3+
description: Our test setup and how our CI files are generated.
4+
sidebar_order: 20
55
---
66

7-
## Our Test Setup
8-
97
The GitHub workflow files for testing specific integration groups (like AI, Web Frameworks, Databases, etc.) are generated by [this script](https://github.com/getsentry/sentry-python/blob/master/scripts/split-tox-gh-actions/split-tox-gh-actions.py). Essentially, the script scans our `tox.ini` and generates the group test CI YAML files in `.github/workflows`.
108

119
There are multiple components to this:
@@ -22,4 +20,4 @@ The AWS Lambda test suite will fail by default on new PRs. If you are an externa
2220

2321
Sensitive test suites (currently only AWS Lambda) require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.
2422

25-
Before running sensitive test suites, maintainers need to carefully check the PR. Then they will apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.
23+
Before running sensitive test suites, maintainers need to carefully check the PR. Then they will apply the `Trigger: tests using secrets` label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

develop-docs/sdk/platform-specifics/python-sdk/feature-branches.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Feature branches
3-
description: How-to for syncing feature branches.
4-
sidebar_order: 40
2+
title: Feature Branches
3+
description: How-to for syncing long-running feature branches.
4+
sidebar_order: 30
55
---
66

77
Sometimes we have long-running feature branches that can't be merged into `master` yet because they contain breaking changes (e.g. `sentry-sdk-2.0`, `potel-base`). They have to be kept in sync with `master` though.

develop-docs/sdk/platform-specifics/python-sdk/api-docs.mdx renamed to develop-docs/sdk/platform-specifics/python-sdk/generating-api-docs.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Generating API docs
3-
description: How to deal with Sphinx issues.
4-
sidebar_order: 10
2+
title: Generating API Docs
3+
description: How to deal with issues generating our API docs.
4+
sidebar_order: 40
55
---
66

77
## Problem

0 commit comments

Comments
 (0)