Simplifying the release process with lightweight automation

未关闭
#888 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
活跃
技术栈
github-actions, java

调研方向

Start by reading the Wayang release process and checking which pre-release and artifact validation steps already exist in the Maven build or CI. The issue proposes a release readiness script but leaves its first checks undecided; agree on a small initial scope before choosing an entry point. Done means the selected checks produce a clear pass/fail summary without duplicating existing CI checks.

由索引模型根据 Issue 内容生成。

描述

I was going through wayang's release process and noticed that there are quite a few manual steps involved.

I was thinking whether we could automate some of these steps to reduce manual effort and avoid possible errors during releases.

A few things we could consider:

1. Pre-release checks
  • Check whether the Git working tree is clean.
  • Verify that version numbers are consistent across Maven modules.
  • Check whether the required release notes and documentation are present.
  • Verify that the required build and tests have passed.
2. Release candidate validation
  • Check whether the expected release artifacts are generated.
  • Verify checksums and GPG signatures.
  • Check whether the source archive contains the required LICENSE and NOTICE files.
3. Release preparation
  • Generate a simple release checklist.
  • Provide a summary of passed and failed checks, possibly through GitHub Actions later.

I donot think we should automate too much at once, as it might make the release process harder to debug and maintain.

maybe we could start with a small release readiness script that handles the basic checks and gradually extend it only where needed. we should also try to reuse existing CI checks rather than introduce duplicate workflows.

I came across rustup from the rust ecosystem and thought something along these lines might be useful for Wayang as well.

would like to know what others think about this and whether we already have some of these checks in place.

主要语言
Java
星标
284
派生
147
平均合并
2 天 13 小时
30 天内合并 PR
13

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

apache/wayang 的其他 Issue

查看 apache/wayang 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。