Skip to content

Commit

Permalink
feat: release v2.0.0 (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
bzp2010 committed Aug 9, 2024
1 parent 82f6f62 commit c34387f
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.5.3
2.0.0
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ $(target_rock):
cd /tmp/random_dir_2cs4f0tghRT/lua-resty-aws; if [ ! "${VERSION}" = "dev" ]; then git checkout ${VERSION}; fi
cd /tmp/random_dir_2cs4f0tghRT/lua-resty-aws; make dev
cd /tmp/random_dir_2cs4f0tghRT; zip -r lua-resty-aws-${VERSION}-1.src.rock lua-resty-aws
cd /tmp/random_dir_2cs4f0tghRT; cat lua-resty-aws/lua-resty-aws-dev-1.rockspec | sed "s/package_version = \"dev\"/package_version = \"${VERSION}\"/" > lua-resty-aws-${VERSION}-1.rockspec
cd /tmp/random_dir_2cs4f0tghRT; zip -r lua-resty-aws-${VERSION}-1.src.rock lua-resty-aws-${VERSION}-1.rockspec
cd /tmp/random_dir_2cs4f0tghRT; cat lua-resty-aws/api7-lua-resty-aws-dev-1.rockspec | sed "s/package_version = \"dev\"/package_version = \"${VERSION}\"/" > api7-lua-resty-aws-${VERSION}-1.rockspec
cd /tmp/random_dir_2cs4f0tghRT; zip -r lua-resty-aws-${VERSION}-1.src.rock api7-lua-resty-aws-${VERSION}-1.rockspec
mv /tmp/random_dir_2cs4f0tghRT/lua-resty-aws-${VERSION}-1.src.rock ./api7-lua-resty-aws-${VERSION}-1.src.rock
-@rm api7-lua-resty-aws-${VERSION}-1.rockspec
mv /tmp/random_dir_2cs4f0tghRT/lua-resty-aws-${VERSION}-1.rockspec ./api7-lua-resty-aws-${VERSION}-1.rockspec
mv /tmp/random_dir_2cs4f0tghRT/api7-lua-resty-aws-${VERSION}-1.rockspec ./api7-lua-resty-aws-${VERSION}-1.rockspec


pack: $(target_rock)
Expand Down
42 changes: 32 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,26 +84,19 @@ different from `false` (which is the default).

Installation is easiest using LuaRocks:

luarocks install lua-resty-aws
luarocks install api7-lua-resty-aws

To install from the git repo:

git clone https://github.com/Kong/lua-resty-aws.git
git clone https://github.com/api7/lua-resty-aws.git
cd lua-resty-aws
make install

### Troubleshooting

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;
luarocks install lua-resty-aws EXPAT_DIR=/path/to/expat

Details: https://github.com/lunarmodules/luaexpat/issues/32

---

## Development

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)
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)
and then run:

make dev
Expand Down Expand Up @@ -156,8 +149,37 @@ Author: Thijs Schreijer

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

## Copyright and license (Modified parts)

Copyright: (c) 2024 API7.ai.

Author: Zeping Bai [@bzp2010](https://github.com/bzp2010)

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

---

## API7 Fork History

Versioning is strictly based on [Semantic Versioning](https://semver.org/), version from 2.0.0.

We may refactor parts of the codebase or add new features, and some of the upstream changes will be synchronized to the fork.

We set up an automated release workflow:

1. Modify the .version file
1. Modify changelog
1. Submit a PR with the name `feat: release vX.Y.Z`
1. Merge PR with the commit name `feat: release vX.Y.Z`

### 2.0.0 (09-Aug-2024)

- feat: remove XML dependency to simplify installation
[1](https://github.com/api7/lua-resty-aws/pull/1)

- ci: add an automated release workflow
[2](https://github.com/api7/lua-resty-aws/pull/2)

## History

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

0 comments on commit c34387f

Please sign in to comment.