-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into sticky-fix
- Loading branch information
Showing
54 changed files
with
2,666 additions
and
255 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
**Detailed Description** | ||
[In-depth description of the changes made to the interfaces, specifying new fields, removed fields, or modified data structures] | ||
|
||
**Impact Analysis** | ||
- **Backward Compatibility**: [Analysis of backward compatibility] | ||
- **Forward Compatibility**: [Analysis of forward compatibility] | ||
|
||
**Testing Plan** | ||
- **Unit Tests**: [Do we have unit test covering the change?] | ||
- **Persistence Tests**: [If the change is related to a data type which is persisted, do we have persistence tests covering the change?] | ||
- **Integration Tests**: [Do we have integration test covering the change?] | ||
- **Compatibility Tests**: [Have we done tests to test the backward and forward compatibility?] | ||
|
||
**Rollout Plan** | ||
- What is the rollout plan? | ||
- Does the order of deployment matter? | ||
- Is it safe to rollback? Does the order of rollback matter? | ||
- Is there a kill switch to mitigate the impact immediately? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
name: Workflow for Breaking Change Reminder | ||
on: | ||
pull_request: | ||
paths: | ||
# below files do not cover all the exposed types/funcs, but it's a good start to detect potentially breaking changes | ||
- activity/activity.go | ||
- client/client.go | ||
- encoded/encoded.go | ||
- interceptors/workflow_interceptor.go | ||
- internal/activity.go | ||
- internal/client.go | ||
- internal/encoded.go | ||
- internal/workflow.go | ||
- internal/interceptors.go | ||
- internal/worker.go | ||
- internal/workflow.go | ||
- worker/worker.go | ||
- workflow/*.go | ||
|
||
jobs: | ||
breaking-change-pr-template-reminder: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Fail if PR description is missing breaking change template | ||
if: steps.pr-changes.outputs.changes != '[]' | ||
run: | | ||
PR_NUMBER=${{ github.event.pull_request.number }} | ||
PR_URL="https://api.github.com/repos/${{ github.repository }}/pulls/${PR_NUMBER}" | ||
BODY=$(curl $PR_URL | jq '.body') | ||
CHECKLIST=( | ||
"Detailed Description" | ||
"Impact Analysis" | ||
"Testing Plan" | ||
"Rollout Plan" | ||
) | ||
TEMPLATE=$(cat .github/workflows/breaking_change_pr_template.md) | ||
for i in "${CHECKLIST[@]}"; do | ||
if [[ "$BODY" == *"$i"* ]]; then | ||
continue | ||
else | ||
echo "Potential breaking changes detected! Please update the PR description to include following template:" | ||
echo "---" | ||
echo "$TEMPLATE" | ||
echo "---" | ||
exit 1 | ||
fi | ||
done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
// Copyright (c) 2017-2021 Uber Technologies Inc. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a copy | ||
// of this software and associated documentation files (the "Software"), to deal | ||
// in the Software without restriction, including without limitation the rights | ||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
// copies of the Software, and to permit persons to whom the Software is | ||
// furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
// THE SOFTWARE. | ||
|
||
package debug | ||
|
||
import ( | ||
internal "go.uber.org/cadence/internal/common/debug" | ||
) | ||
|
||
type ( | ||
// PollerTracker is an interface to track running pollers on a worker | ||
// Deprecated: in development and very likely to change | ||
PollerTracker = internal.PollerTracker | ||
|
||
// Stopper is an interface for tracking stop events in an ongoing process or goroutine. | ||
// Implementations should ensure that Stop() is used to signal and track the stop event | ||
// and not to clean up any resources opened by worker | ||
// Deprecated: in development and very likely to change | ||
Stopper = internal.Stopper | ||
|
||
// WorkerStats provides a set of methods that can be used to collect | ||
// stats on the Worker for debugging purposes. | ||
// Deprecated: in development and very likely to change | ||
WorkerStats = internal.WorkerStats | ||
|
||
// ActivityTracker is a worker option to track executing activities on a worker | ||
// Deprecated: in development and very likely to change | ||
ActivityTracker = internal.ActivityTracker | ||
|
||
// ActivityInfo contains details on the executing activity | ||
// Deprecated: in development and very likely to change | ||
ActivityInfo = internal.ActivityInfo | ||
|
||
// Activities is a list of executing activities on the worker | ||
// Deprecated: in development and very likely to change | ||
Activities = internal.Activities | ||
|
||
// Debugger exposes stats collected on a running Worker | ||
// Deprecated: in development and very likely to change | ||
Debugger = internal.Debugger | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.