Skip to content

Commit 97a11c9

Browse files
authored
Add description
1 parent 4f875cf commit 97a11c9

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

README.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,67 @@
11
# 3rd-build-ga
22

3-
Build 3rd on GitHub Actions
3+
All binaries that used in [Amnezia-VPN](https://github.com/amnezia-vpn) project built in this repository.
4+
5+
### Usage
6+
7+
This repository contains GitHub Action for each project module.
8+
9+
Build action is triggered by commit message with build type.
10+
11+
### Build types
12+
13+
Build all modules:
14+
- [all]
15+
16+
Build all modules on specific platform:
17+
- [linux]
18+
- [macos]
19+
- [windows]
20+
- [android]
21+
- [ios]
22+
23+
Build specific module for all platform:
24+
- [awg]
25+
- [xray]
26+
- [cloak]
27+
- [libssh]
28+
- [openssl]
29+
- [openvpn]
30+
- [openvpnadapter]
31+
- [shadowsocks]
32+
- [tun2socks]
33+
34+
Build module for defined platform:
35+
- [macos-awg]
36+
- [linux-awg]
37+
- [ios-awg]
38+
- [android-awg]
39+
- [windows-awg]
40+
- [android-libssh]
41+
- [ios-libssh]
42+
- [linux-libssh]
43+
- [windows-libssh]
44+
- [macos-libssh]
45+
- [android-openssl]
46+
- [linux-openssl]
47+
- [macos-openssl]
48+
- [ios-openssl]
49+
- [windows-openssl]
50+
- [android-openvpn]
51+
- [linux-openvpn]
52+
- [macos-openvpn]
53+
- [windows-openvpn]
54+
- [openvpnadapter-macos]
55+
- [android-shadowsocks]
56+
- [linux-shadowsocks]
57+
- [ios-xray]
58+
- [android-xray]
59+
60+
### Release
61+
62+
You need to make a release from your action if you want to use built output in main repository.
63+
64+
We use tags for Release job start. Just put a tag on commit message to store your built output in [GitHub release](https://github.com/amnezia-vpn/3rd-build-ga/releases).
65+
66+
Binaries from [GitHub release](https://github.com/amnezia-vpn/3rd-build-ga/releases) can be uploaded into [3rd-prebuilt](https://github.com/amnezia-vpn/3rd-prebuilt) with sha256 sum and then you can update [3rd-prebuilt](https://github.com/amnezia-vpn/3rd-prebuilt) in main repository.
67+

0 commit comments

Comments
 (0)