Skip to content

Improve release doc and script#13147

Merged
wu-sheng merged 4 commits into
apache:masterfrom
kezhenxu94:master
Mar 28, 2025
Merged

Improve release doc and script#13147
wu-sheng merged 4 commits into
apache:masterfrom
kezhenxu94:master

Conversation

@kezhenxu94
Copy link
Copy Markdown
Member

  • If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #.
  • Update the CHANGES log.

@kezhenxu94 kezhenxu94 requested review from Copilot and wu-sheng March 27, 2025 05:13
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the release documentation to improve the process of creating release artifacts and starting the next release iteration.

  • Header changes to clarify the artifact creation process.
  • Replaces detailed manual steps with streamlined commands that download and execute release scripts.
  • Removes outdated manual instructions for building and tagging releases.
Files not reviewed (3)
  • docs/en/changes/changes.tpl: Language not supported
  • tools/releasing/create_release_tars.sh: Language not supported
  • tools/releasing/start_next_version.sh: Language not supported
Comments suppressed due to low confidence (2)

docs/en/guides/How-to-release.md:19

  • Consider adding a verification step (e.g., checksum validation) for the downloaded script to mitigate potential security risks from remote script execution.
curl -Ls https://raw.githubusercontent.com/apache/skywalking/refs/heads/master/tools/releasing/create_release_tars.sh | bash -

docs/en/guides/How-to-release.md:38

  • It is unclear what this script does compared to the previous manual instructions. Please add a brief explanation or a link to documentation outlining the changes performed by this script.
curl -Ls https://raw.githubusercontent.com/apache/skywalking/refs/heads/master/tools/releasing/start_next_version.sh | bash -

Comment thread docs/en/guides/How-to-release.md
wu-sheng
wu-sheng previously approved these changes Mar 27, 2025
Copy link
Copy Markdown
Member

@wu-sheng wu-sheng left a comment

Choose a reason for hiding this comment

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

Cool. It is great to have release scripts more automatically.

@wu-sheng wu-sheng added this to the 10.3.0 milestone Mar 27, 2025
@wu-sheng
Copy link
Copy Markdown
Member

@kezhenxu94 Kafka case fails due to the reason I sent to you yesterday night. And we only got temp fix through locking version.

@kezhenxu94
Copy link
Copy Markdown
Member Author

@kezhenxu94 Kafka case fails due to the reason I sent to you yesterday night. And we only got temp fix through locking version.

Locking version is not a temp fix in my opinion, it’s always a good practice to lock versions of dependencies to not break CI all of a sudden

@wu-sheng
Copy link
Copy Markdown
Member

@kezhenxu94 Kafka case fails due to the reason I sent to you yesterday night. And we only got temp fix through locking version.

Locking version is not a temp fix in my opinion, it’s always a good practice to lock versions of dependencies to not break CI all of a sudden

Yes. That is true. My intention was, the version lock is for a previous version, not for the latest.

@wu-sheng
Copy link
Copy Markdown
Member

About #13144, I am waiting for hot/warm/cold doc update, then we could merge that.

@wu-sheng wu-sheng added the documentation Provide documents related issue or pull request only. label Mar 28, 2025
wu-sheng
wu-sheng previously approved these changes Mar 28, 2025
@wu-sheng wu-sheng merged commit ba639e3 into apache:master Mar 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Provide documents related issue or pull request only.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants