Skip to content

Commit e6f468e

Browse files
authored
feat: release v2.0.0 (#4)
1 parent 82f6f62 commit e6f468e

File tree

2 files changed

+33
-11
lines changed

2 files changed

+33
-11
lines changed

.version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.5.3
1+
2.0.0

README.md

+32-10
Original file line numberDiff line numberDiff line change
@@ -84,26 +84,19 @@ different from `false` (which is the default).
8484

8585
Installation is easiest using LuaRocks:
8686

87-
luarocks install lua-resty-aws
87+
luarocks install api7-lua-resty-aws
8888

8989
To install from the git repo:
9090

91-
git clone https://github.com/Kong/lua-resty-aws.git
91+
git clone https://github.com/api7/lua-resty-aws.git
9292
cd lua-resty-aws
9393
make install
9494

95-
### Troubleshooting
96-
97-
MacOS has a known issue that the libexpat header file 'expat_config.h' is missing. If you run into that issue, install libexpat manually (eg. `brew install expat`). And then include the libexpat location when installing;
98-
luarocks install lua-resty-aws EXPAT_DIR=/path/to/expat
99-
100-
Details: https://github.com/lunarmodules/luaexpat/issues/32
101-
10295
---
10396

10497
## Development
10598

106-
To update the SDK version being used edit the version tag in [`update_api_files.sh`](https://github.com/Kong/lua-resty-aws/blob/main/update_api_files.sh)
99+
To update the SDK version being used edit the version tag in [`update_api_files.sh`](https://github.com/api7/lua-resty-aws/blob/main/update_api_files.sh)
107100
and then run:
108101

109102
make dev
@@ -156,8 +149,37 @@ Author: Thijs Schreijer
156149

157150
License: [Apache 2.0](https://github.com/Kong/lua-resty-aws/blob/main/LICENSE)
158151

152+
## Copyright and license (Modified parts)
153+
154+
Copyright: (c) 2024 API7.ai.
155+
156+
Author: Zeping Bai [@bzp2010](https://github.com/bzp2010)
157+
158+
License: [Apache 2.0](https://github.com/api7/lua-resty-aws/blob/main/LICENSE)
159+
159160
---
160161

162+
## API7 Fork History
163+
164+
Versioning is strictly based on [Semantic Versioning](https://semver.org/), version from 2.0.0.
165+
166+
We may refactor parts of the codebase or add new features, and some of the upstream changes will be synchronized to the fork.
167+
168+
We set up an automated release workflow:
169+
170+
1. Modify the .version file
171+
1. Modify changelog
172+
1. Submit a PR with the name `feat: release vX.Y.Z`
173+
1. Merge PR with the commit name `feat: release vX.Y.Z`
174+
175+
### 2.0.0 (09-Aug-2024)
176+
177+
- feat: remove XML dependency to simplify installation
178+
[1](https://github.com/api7/lua-resty-aws/pull/1)
179+
180+
- ci: add an automated release workflow
181+
[2](https://github.com/api7/lua-resty-aws/pull/2)
182+
161183
## History
162184

163185
Versioning is strictly based on [Semantic Versioning](https://semver.org/)

0 commit comments

Comments
 (0)