[TT-9493] Detect breaking changes with github action #5370
Conversation
|
API tests result: success ✅ |
|
API Changes --- prev.txt 2023-08-22 21:04:43.182448557 +0000
+++ current.txt 2023-08-22 21:04:36.866427018 +0000
@@ -9762,6 +9762,19 @@
func TransferEncoding(req *http.Request) string
TransferEncoding gets the header value from the request.
+# Package: ./internal/maps
+
+package maps // import "github.com/TykTechnologies/tyk/internal/maps"
+
+
+TYPES
+
+type FlatMap map[string]string
+ FlatMap is alias of map[string]string.
+
+func Flatten(data map[string]interface{}) (flatmap FlatMap, err error)
+ Flatten transforms deep map to flat map.
+
# Package: ./internal/middleware
package middleware // import "github.com/TykTechnologies/tyk/internal/middleware"
@@ -9890,12 +9903,6 @@
TYPES
-type FlatMap map[string]string
- FlatMap is alias of map[string]string
-
-func Flatten(data map[string]interface{}) (flatmap FlatMap, err error)
- Flatten transform complex map to flatten map
-
type RawFormatter struct{}
func (f *RawFormatter) Format(entry *logrus.Entry) ([]byte, error) |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
API tests result: failure 🚫 |
titpetric
changed the title
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
5 similar comments
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
API tests result: success ✅ |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
API tests result: success ✅ |
|
💔 The detected issue is not in one of the allowed statuses 💔
Please ensure your jira story is in one of the allowed statuses |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
I'm a bot and I 👍 this PR title. 🤖 |
|
SonarCloud Quality Gate failed.
|
|
API tests result: success ✅ |
|
API tests result: success ✅ |
|
/release to release-5.2 |
|
/release to release-5-lts |
|
Working on it! Note that it can take a few minutes. |
<details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-9493" title="TT-9493" target="_blank">TT-9493</a></summary> <br /> <table> <tr> <th>Summary</th> <td>BE/Go: Detect breaking changes with go doc</td> </tr> <tr> <th>Type</th> <td> <img alt="Story" src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium" /> Story </td> </tr> <tr> <th>Status</th> <td>In Dev</td> </tr> <tr> <th>Points</th> <td>N/A</td> </tr> <tr> <th>Labels</th> <td>-</td> </tr> </table> </details> <!-- do not remove this marker as it will break jira-lint's functionality. added_by_jira_lint --> --- This PR creates a github action that compares the output of godoc for the PR, against base_ref. This surfaces any API change, including documentation changes. As an example, `log.Flatten` was moved under `internal/maps` package, demonstrating the resulting comment. The action only creates or updates 1 comment on the PR. https://tyktech.atlassian.net/browse/TT-9493 --------- Co-authored-by: Tit Petric <tit@tyk.io> (cherry picked from commit 863f695)
|
@titpetric Succesfully merged PR |
|
/release to release-5.2 |
|
Working on it! Note that it can take a few minutes. |
|
@titpetric Succesfully merged PR |
<details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-9493" title="TT-9493" target="_blank">TT-9493</a></summary> <br /> <table> <tr> <th>Summary</th> <td>BE/Go: Detect breaking changes with go doc</td> </tr> <tr> <th>Type</th> <td> <img alt="Story" src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium" /> Story </td> </tr> <tr> <th>Status</th> <td>In Dev</td> </tr> <tr> <th>Points</th> <td>N/A</td> </tr> <tr> <th>Labels</th> <td>-</td> </tr> </table> </details> <!-- do not remove this marker as it will break jira-lint's functionality. added_by_jira_lint --> --- This PR creates a github action that compares the output of godoc for the PR, against base_ref. This surfaces any API change, including documentation changes. As an example, `log.Flatten` was moved under `internal/maps` package, demonstrating the resulting comment. The action only creates or updates 1 comment on the PR. https://tyktech.atlassian.net/browse/TT-9493 --------- Co-authored-by: Tit Petric <tit@tyk.io> (cherry picked from commit 863f695)
…ub action (#5370) [TT-9493] Detect breaking changes with github action (#5370) <details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-9493" title="TT-9493" target="_blank">TT-9493</a></summary> <br /> <table> <tr> <th>Summary</th> <td>BE/Go: Detect breaking changes with go doc</td> </tr> <tr> <th>Type</th> <td> <img alt="Story" src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium" /> Story </td> </tr> <tr> <th>Status</th> <td>In Dev</td> </tr> <tr> <th>Points</th> <td>N/A</td> </tr> <tr> <th>Labels</th> <td>-</td> </tr> </table> </details> <!-- do not remove this marker as it will break jira-lint's functionality. added_by_jira_lint --> --- This PR creates a github action that compares the output of godoc for the PR, against base_ref. This surfaces any API change, including documentation changes. As an example, `log.Flatten` was moved under `internal/maps` package, demonstrating the resulting comment. The action only creates or updates 1 comment on the PR. https://tyktech.atlassian.net/browse/TT-9493 --------- Co-authored-by: Tit Petric <tit@tyk.io>
… action (#5370) [TT-9493] Detect breaking changes with github action (#5370) <details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-9493" title="TT-9493" target="_blank">TT-9493</a></summary> <br /> <table> <tr> <th>Summary</th> <td>BE/Go: Detect breaking changes with go doc</td> </tr> <tr> <th>Type</th> <td> <img alt="Story" src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium" /> Story </td> </tr> <tr> <th>Status</th> <td>In Dev</td> </tr> <tr> <th>Points</th> <td>N/A</td> </tr> <tr> <th>Labels</th> <td>-</td> </tr> </table> </details> <!-- do not remove this marker as it will break jira-lint's functionality. added_by_jira_lint --> --- This PR creates a github action that compares the output of godoc for the PR, against base_ref. This surfaces any API change, including documentation changes. As an example, `log.Flatten` was moved under `internal/maps` package, demonstrating the resulting comment. The action only creates or updates 1 comment on the PR. https://tyktech.atlassian.net/browse/TT-9493 --------- Co-authored-by: Tit Petric <tit@tyk.io>
TT-9493
This PR creates a github action that compares the output of godoc for the PR, against base_ref. This surfaces any API change, including documentation changes.
As an example,
log.Flattenwas moved underinternal/mapspackage, demonstrating the resulting comment.The action only creates or updates 1 comment on the PR.
https://tyktech.atlassian.net/browse/TT-9493