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

Write release doc for RM. #109

Merged
merged 3 commits into from
Aug 18, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Apache SkyWalking Nginx LUA agent release guide

SkyWalking Nginx LUA agent released through source tar on the [website](https://skywalking.apache.org/downloads/#NginxLUAAgent)
and [SkyWalking's LuaRock Module](https://luarocks.org/modules/apache-skywalking/skywalking-nginx-lua).

Release manager could follow this doc to build and upload a release for this agent.

1. Prepare the new `.rockspec` file for the new release. Ref previous and latest files in [here](./rockspec/).
2. Update the [changelogs](CHANGES.md) for the upcoming release.
3. Tag through git or GitHub.
4. Build the source tars with ASC sign and SHA512

```shell
> export RELEASE_VERSION=x.y.z

> tar czf skywalking-nginx-lua-${RELEASE_VERSION}-src.tgz \
Copy link
Contributor

Choose a reason for hiding this comment

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

There is already a release.md file, Do we recommend using make release-src here ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops, I missed that. I am going to merge these two.

--exclude .git \
--exclude .DS_Store \
--exclude .github \
--exclude .gitignore \
--exclude .gitmodules \
--exclude .mvn/wrapper/maven-wrapper.jar \
skywalking-nginx-lua

> gpg --armor --detach-sig skywalking-nginx-lua-${RELEASE_VERSION}-src.tgz

> shasum -a 512 skywalking-nginx-lua-${RELEASE_VERSION}-src.tgz > skywalking-nginx-lua-${RELEASE_VERSION}-src.tgz.sha512

```

5. Upload `*-src.tgz`, `*-src.tgz.asc` and `*-src.tgz.sha512` to SVN `https://dist.apache.org/repos/dist/release/skywalking/nginx-lua/${RELEASE_VERSION}`

6. Call for vote through `dev@skywalking.apache.org` mailing list.

```
Hi all,

This is a call for vote to release Apache SkyWalking Nginx LUA version ${RELEASE_VERSION}.

Release notes:

* https://github.com/apache/skywalking-nginx-lua/blob/v${RELEASE_VERSION}/CHANGES.md

Release Candidate:

* https://dist.apache.org/repos/dist/dev/skywalking/nginx-lua/${RELEASE_VERSION}/
* sha512 checksums
- xxx skywalking-nginx-lua-${RELEASE_VERSION}-src.tgz

Release Tag :

* v${RELEASE_VERSION}

Release CommitID :

* https://dist.apache.org/repos/dist/dev/skywalking/nginx-lua/${COMMIT_ID}

Keys to verify the Release Candidate :

* https://dist.apache.org/repos/dist/release/skywalking/KEYS


Voting will start now (Date) and will remain open for at least
72 hours, Request all PMC members to give their vote.
[ ] +1 Release this package.
[ ] +0 No opinion.
[ ] -1 Do not release this package because....
```

7. If the vote passed with at least +1 binding(s) and more +1 binding(s) than -1 binding(s), the vote pass.

8. Upload the rockspec to LuaRocks

> luarocks upload skywalking-nginx-lua-${RELEASE_VERSION}-0.rockspec
wu-sheng marked this conversation as resolved.
Show resolved Hide resolved

9. Move the source tar from svn dev folder to the release folder.

> svn mv https://dist.apache.org/repos/dist/dev/skywalking/nginx-lua/${RELEASE_VERSION} https://dist.apache.org/repos/dist/release/skywalking/nginx-lua

10. Update website event page accordingly.
Loading