Skip to content

Commit d44731f

Browse files
authored
Set up release makefile and doc. (#14)
1 parent c6aca51 commit d44731f

File tree

2 files changed

+51
-3
lines changed

2 files changed

+51
-3
lines changed

Makefile

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one or more
2+
# contributor license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright ownership.
4+
# The ASF licenses this file to You under the Apache License, Version 2.0
5+
# (the "License"); you may not use this file except in compliance with
6+
# the License. You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
SHELL := /bin/bash -o pipefail
17+
18+
VERSION ?= latest
19+
RELEASE_SRC = skywalking-nginx-lua-${VERSION}-src
20+
21+
release-src:
22+
tar -zcvf $(RELEASE_SRC).tgz \
23+
--exclude bin \
24+
--exclude .git \
25+
--exclude .idea \
26+
--exclude .gitignore \
27+
--exclude .DS_Store \
28+
--exclude .github \
29+
.
30+
31+
gpg --batch --yes --armor --detach-sig $(RELEASE_SRC).tgz
32+
shasum -a 512 $(RELEASE_SRC).tgz > $(RELEASE_SRC).tgz.sha512
33+
34+
mkdir -p release
35+
mv $(RELEASE_SRC).tgz release/$(RELEASE_SRC).tgz
36+
mv $(RELEASE_SRC).tgz.asc release/$(RELEASE_SRC).tgz.asc
37+
mv $(RELEASE_SRC).tgz.sha512 release/$(RELEASE_SRC).tgz.sha512

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,14 @@ http {
6868
}
6969
```
7070

71+
# Download
72+
Please head to the [releases page](http://skywalking.apache.org/downloads/) to download a release of Apache SkyWalking.
73+
74+
# Compatible backend
75+
SkyWalking OAP begins to support LUA agent in 7.0.0 release.
76+
77+
You could choose master branch before the official 7.0.0 release.
78+
7179
# Set up dev env
7280
### Debug Startup
7381
By using the `/examples/nginx.conf`, you could start the Nginx with LUA module or OpenResty. Such as `nginx -c /path/to/skywalking-nginx-lua/examples/nginx.conf`
@@ -121,14 +129,17 @@ Create 2 kinds of span
121129
- `TracingContext.createExitSpan(operationName, parent, peer, contextCarrier)`
122130

123131

124-
# Download
125-
Have no release yet.
126-
127132
# Contact Us
128133
* Submit an [issue](https://github.com/apache/skywalking/issues) with `[NIGNX-LUA]` as the issue title prefix.
129134
* Mail list: **[email protected]**. Mail to `[email protected]`, follow the reply to subscribe the mail list.
130135
* Join `skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY). If the link is not working, find the latest one at [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
131136
* QQ Group: 392443393(2000/2000, not available), 901167865(available)
132137

138+
# Release Tar Build
139+
```shell
140+
> export VERSION=x.y.z
141+
> make release-src
142+
```
143+
133144
# License
134145
Apache 2.0

0 commit comments

Comments
 (0)