Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate Go 1.21 and add 1.24 #1055

Merged
merged 3 commits into from
Feb 19, 2025
Merged

Deprecate Go 1.21 and add 1.24 #1055

merged 3 commits into from
Feb 19, 2025

Conversation

klauspost
Copy link
Owner

@klauspost klauspost commented Feb 19, 2025

Remove old docs, prep for new release.

Summary by CodeRabbit

  • Documentation

    • Updated the changelog with new release entries detailing enhancements and bug fixes in compression functionality, offering improved performance and reliability.
  • Chores

    • Upgraded the build and release processes to use a more recent Go version, ensuring better overall stability and quality.

Remove old docs, prep for new release.
Copy link

coderabbitai bot commented Feb 19, 2025

📝 Walkthrough

Walkthrough

The changes update the CI configurations, module declarations, changelog documentation, and test output formatting. In the GitHub Actions workflows, the Go versions have been revised—jobs in the go.yml and the setup in release.yml now reference version 1.24.x instead of older ones. The module files (go.mod and s2sx.mod) have been updated to require Go 1.22 rather than 1.21. Additionally, new release entries have been added to the README changelog, and error messages in tests have been reformatted to use fmt.Sprintf for improved readability. No public API declarations were altered.

Changes

File(s) Change Summary
.github/workflows/go.yml, .github/workflows/release.yml Updated Go versions in CI workflows: in go.yml, the matrix and job-specific go-version values were shifted to use 1.24.x; in release.yml, the setup step now specifies 1.24.x.
README.md Added new changelog entries detailing releases for versions 1.18.0 and 1.17.11, and streamlined existing entries by removing author attributions.
fse/fse_test.go Reformatted error messages in tests using fmt.Sprintf instead of string concatenation, enhancing clarity in the output during test failures.
go.mod, s2sx.mod, s2/cmd/_s2sx/go.mod Upgraded the module declarations to require Go version 1.22, replacing the previous requirement of 1.21. Additionally, the toolchain version in s2/cmd/_s2sx/go.mod was updated.

Possibly related PRs


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27f2131 and f499dbd.

📒 Files selected for processing (3)
  • .github/workflows/go.yml (6 hunks)
  • .github/workflows/release.yml (1 hunks)
  • s2/cmd/_s2sx/go.mod (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • s2/cmd/_s2sx/go.mod
🚧 Files skipped from review as they are similar to previous changes (2)
  • .github/workflows/release.yml
  • .github/workflows/go.yml
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: build (1.23.x, macos-latest)
  • GitHub Check: build (1.22.x, windows-latest)
  • GitHub Check: fuzz-s2 ("noasm,nounsafe")
  • GitHub Check: build (1.22.x, macos-latest)
  • GitHub Check: fuzz-zstd ("noasm,nounsafe")
  • GitHub Check: fuzz-s2 (nounsafe)
  • GitHub Check: fuzz-other ("noasm,nounsafe")
  • GitHub Check: build (1.22.x, ubuntu-latest)
  • GitHub Check: fuzz-zstd (nounsafe)
  • GitHub Check: fuzz-other (nounsafe)
  • GitHub Check: build-special

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (2)

30-38: New Changelog Entries for Release 1.18.0
New changelog entries have been added for the Feb 19th, 2025 release ([1.18.0]). The bullet points clearly list the improvements and fixes introduced in this update.

Consider revising the formatting of the URLs in these entries. For example, adopting markdown link syntax (e.g., [description](URL)) or wrapping bare URLs in angle brackets (<...>) can improve readability and help satisfy markdown linting rules (MD034).

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

31-31: Bare URL used
null

(MD034, no-bare-urls)


32-32: Bare URL used
null

(MD034, no-bare-urls)


33-33: Bare URL used
null

(MD034, no-bare-urls)


34-34: Bare URL used
null

(MD034, no-bare-urls)


35-35: Bare URL used
null

(MD034, no-bare-urls)


36-36: Bare URL used
null

(MD034, no-bare-urls)


37-37: Bare URL used
null

(MD034, no-bare-urls)


594-602: Markdown Formatting Consistency
Static analysis indicates several markdown formatting issues (bare URLs, unordered list indentation, and hard tabs). It would be beneficial to standardize the markdown formatting throughout the document to improve consistency and readability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df8e99c and 27f2131.

📒 Files selected for processing (6)
  • .github/workflows/go.yml (6 hunks)
  • .github/workflows/release.yml (1 hunks)
  • README.md (8 hunks)
  • fse/fse_test.go (2 hunks)
  • go.mod (1 hunks)
  • s2sx.mod (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • s2sx.mod
  • go.mod
  • fse/fse_test.go
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

31-31: Bare URL used
null

(MD034, no-bare-urls)


32-32: Bare URL used
null

(MD034, no-bare-urls)


33-33: Bare URL used
null

(MD034, no-bare-urls)


34-34: Bare URL used
null

(MD034, no-bare-urls)


35-35: Bare URL used
null

(MD034, no-bare-urls)


36-36: Bare URL used
null

(MD034, no-bare-urls)


37-37: Bare URL used
null

(MD034, no-bare-urls)


40-40: Bare URL used
null

(MD034, no-bare-urls)


41-41: Bare URL used
null

(MD034, no-bare-urls)


42-42: Bare URL used
null

(MD034, no-bare-urls)


43-43: Bare URL used
null

(MD034, no-bare-urls)


94-94: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


94-94: Hard tabs
Column: 1

(MD010, no-hard-tabs)


94-94: Bare URL used
null

(MD034, no-bare-urls)


95-95: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


95-95: Hard tabs
Column: 1

(MD010, no-hard-tabs)


95-95: Bare URL used
null

(MD034, no-bare-urls)


96-96: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


96-96: Hard tabs
Column: 1

(MD010, no-hard-tabs)


96-96: Bare URL used
null

(MD034, no-bare-urls)


153-153: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


153-153: Hard tabs
Column: 1

(MD010, no-hard-tabs)


153-153: Bare URL used
null

(MD034, no-bare-urls)


196-196: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


196-196: Hard tabs
Column: 1

(MD010, no-hard-tabs)


196-196: Bare URL used
null

(MD034, no-bare-urls)


238-238: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


238-238: Hard tabs
Column: 1

(MD010, no-hard-tabs)


238-238: Bare URL used
null

(MD034, no-bare-urls)


265-265: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


265-265: Hard tabs
Column: 1

(MD010, no-hard-tabs)


266-266: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


266-266: Hard tabs
Column: 1

(MD010, no-hard-tabs)


267-267: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


267-267: Hard tabs
Column: 1

(MD010, no-hard-tabs)


268-268: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


268-268: Hard tabs
Column: 1

(MD010, no-hard-tabs)


269-269: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


269-269: Hard tabs
Column: 1

(MD010, no-hard-tabs)


270-270: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


270-270: Hard tabs
Column: 1

(MD010, no-hard-tabs)


287-287: Unordered list indentation
Expected: 2; Actual: 1

(MD007, ul-indent)


287-287: Hard tabs
Column: 1

(MD010, no-hard-tabs)

⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: build (1.24.x, windows-latest)
  • GitHub Check: build (1.24.x, macos-latest)
  • GitHub Check: build (1.24.x, ubuntu-latest)
  • GitHub Check: build (1.23.x, windows-latest)
  • GitHub Check: build (1.23.x, macos-latest)
  • GitHub Check: fuzz-zstd ("noasm,nounsafe")
  • GitHub Check: build (1.23.x, ubuntu-latest)
  • GitHub Check: fuzz-zstd (nounsafe)
  • GitHub Check: fuzz-s2 ("noasm,nounsafe")
  • GitHub Check: build (1.22.x, windows-latest)
  • GitHub Check: fuzz-s2 (nounsafe)
  • GitHub Check: build (1.22.x, macos-latest)
  • GitHub Check: fuzz-other ("noasm,nounsafe")
  • GitHub Check: build (1.22.x, ubuntu-latest)
  • GitHub Check: fuzz-other (nounsafe)
🔇 Additional comments (7)
.github/workflows/release.yml (1)

22-25: Update Go Version for GoReleaser Setup
The go-version in the actions/setup-go step is updated to 1.24.x, which aligns with the project's new supported Go version. This change ensures that the release workflow uses the latest version as outlined in the PR objectives.

.github/workflows/go.yml (6)

14-16: Update Go-Version Matrix in Build Job
The Go version matrix is modified to remove the deprecated 1.21.x and add 1.24.x. This update ensures that the build process tests against the supported range: 1.22.x, 1.23.x, 1.24.x.


61-64: Set Go Version in Generate Job
The generate job now specifies go-version: 1.24.x, which is consistent with the new version support.


83-86: Update Go Version in Build-Special Job
The build-special job’s setup has been updated to use Go version 1.24.x, supporting the overall CI shift to the latest version.


126-129: Update Go Version in Fuzz-S2 Job
The fuzz-s2 job has been updated with go-version: 1.24.x, aligning the fuzz tests with the new Go version requirement.


152-155: Update Go Version in Fuzz-Zstd Job
The go-version in the fuzz-zstd job is now set to 1.24.x, ensuring that tests for the zstd package run on the current supported Go version.


183-186: Update Go Version in Fuzz-Other Job
The fuzz-other job also uses go-version: 1.24.x now, maintaining consistency across all CI jobs regarding the Go version used.

@klauspost klauspost merged commit 8e79dc4 into master Feb 19, 2025
22 checks passed
@klauspost klauspost deleted the deprecate-121 branch February 19, 2025 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant