chore: Document godebug flag usage#3429
Merged
Merged
Conversation
sfc-gh-jcieslak
force-pushed
the
document-godebug-flag-usage
branch
from
815eae5 to
73ba109
Compare
|
Integration tests cancelled for 73ba1093e0650f605c2aca7291247f6964066654 |
There was a problem hiding this comment.
PR Overview
This PR documents the usage of the GODEBUG flag as a workaround for Go standard library changes that affect compatibility with Suricata-based firewalls, as described in issue #3421.
- Adds documentation in MIGRATION_GUIDE.md for the new Go version (v1.23.6) and the GODEBUG workaround.
- Updates CREATING_ISSUES.md to reference Go-related issues and link to the migration guide for detailed instructions.
Reviewed Changes
| File | Description |
|---|---|
| MIGRATION_GUIDE.md | Added a new section to document the Go version bump and GODEBUG usage. |
| CREATING_ISSUES.md | Included a new bullet and detailed section on handling Go-related firewall issues. |
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
sfc-gh-jmichalak
approved these changes
Mar 3, 2025
sfc-gh-jmichalak
approved these changes
Mar 3, 2025
sfc-gh-asawicki
approved these changes
Mar 4, 2025
sfc-gh-jmichalak
pushed a commit
that referenced
this pull request
Mar 24, 2025
Document issue #3421 and how the godebug environment variable can be used to turn off some of the Go features that may not always be compatible with third-party software (like firewalls).
sfc-gh-jmichalak
pushed a commit
that referenced
this pull request
Mar 25, 2025
🤖 I have created a release *beep* *boop* --- ## [1.0.5](v1.0.4...v1.0.5) (2025-03-25) ### 🔧 **Misc** * Bump tracking version to v1.0.5 ([#3460](#3460)) ([2af79e6](2af79e6)) * Bump tracking version to v1.0.5 ([#3460](#3460)) ([3aaf555](3aaf555)) * Document godebug flag usage ([#3429](#3429)) ([5f04947](5f04947)) * Document godebug flag usage ([#3429](#3429)) ([2dce172](2dce172)) * fix failing tests ([#3428](#3428)) ([884ca54](884ca54)) * fix failing tests ([#3428](#3428)) ([245fd86](245fd86)) * Fix migration guide ([#3468](#3468)) ([6540841](6540841)) * GitHub actions cleanup ([#3431](#3431)) ([1cc6d80](1cc6d80)) * GitHub actions cleanup ([#3431](#3431)) ([a6e7429](a6e7429)) * Protect pentesting user and role from sweepers ([#3426](#3426)) ([1478c5e](1478c5e)) * Protect pentesting user and role from sweepers ([#3426](#3426)) ([6354dba](6354dba)) * Remove driver instrumentation ([#3439](#3439)) ([61802a8](61802a8)) * Remove driver instrumentation ([#3439](#3439)) ([e9fc6ed](e9fc6ed)) * Remove SF_TF_ADDITIONAL_DEBUG_LOGGING ([#3441](#3441)) ([cab63e9](cab63e9)) * Remove SF_TF_ADDITIONAL_DEBUG_LOGGING ([#3441](#3441)) ([b57db81](b57db81)) * Update GitHub actions ([#3455](#3455)) ([3b027a8](3b027a8)) * Update GitHub actions ([#3455](#3455)) ([368f090](368f090)) * Use environmental secrets in GitHub Actions ([#3440](#3440)) ([6048977](6048977)) * Use environmental secrets in GitHub Actions ([#3440](#3440)) ([8e5a262](8e5a262)) ### 🐛 **Bug fixes:** * Add boolean env validations and unit tests for TOML config validation ([#3453](#3453)) ([c113928](c113928)) * Add boolean env validations and unit tests for TOML config validation ([#3453](#3453)) ([408db4e](408db4e)) * Adjust docs ([#3451](#3451)) ([46d071d](46d071d)) * Adjust docs ([#3451](#3451)) ([29b0e4d](29b0e4d)) * Apply new assertions setup ([#3409](#3409)) ([e5fdced](e5fdced)) * Apply new assertions setup ([#3409](#3409)) ([af83da0](af83da0)) * Correct a typo in a tag resource example ([#3446](#3446)) ([a0202d1](a0202d1)) * Correct a typo in a tag resource example ([#3446](#3446)) ([afd19a2](afd19a2)) * Fix datasource acceptance tests setup part1 ([#3443](#3443)) ([58126ea](58126ea)) * Fix datasource acceptance tests setup part1 ([#3443](#3443)) ([5046654](5046654)) * Fix datasource acceptance tests setup part2 ([#3445](#3445)) ([6c7ceeb](6c7ceeb)) * Fix datasource acceptance tests setup part2 ([#3445](#3445)) ([4ba2bb6](4ba2bb6)) * Fix datasource acceptance tests setup part3 ([#3448](#3448)) ([5475c69](5475c69)) * Fix datasource acceptance tests setup part3 ([#3448](#3448)) ([f6fdc17](f6fdc17)) * Fix datasource acceptance tests setup part4 ([#3449](#3449)) ([04e082a](04e082a)) * Fix datasource acceptance tests setup part4 ([#3449](#3449)) ([935d969](935d969)) * Fix tasks tests ([#3434](#3434)) ([33ab740](33ab740)) * Fix tasks tests ([#3434](#3434)) ([b5457f6](b5457f6)) * Handle TOML file permissions ([#3444](#3444)) ([6c746b4](6c746b4)) * Handle TOML file permissions ([#3444](#3444)) ([e4ed171](e4ed171)) * Limit TOML file size ([#3432](#3432)) ([55fcbe3](55fcbe3)) * Limit TOML file size ([#3432](#3432)) ([2e12981](2e12981)) * Quick fix assertions ([#3438](#3438)) ([0e05c6f](0e05c6f)) * Quick fix assertions ([#3438](#3438)) ([a430ba7](a430ba7)) * Skip file permission verification by default ([#3476](#3476)) ([562173d](562173d)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: snowflake-release-please[bot] <105954990+snowflake-release-please[bot]@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document issue #3421 and how the godebug environment variable can be used to turn off some of the Go features that may not always be compatible with third-party software (like firewalls).