Merge pull request #85 from amplify-education/feature/AT-8360-improve

General improvements

Author: mluhovyi

.github/workflows/publish.yml

@@ -28,6 +28,8 @@ jobs:
       - name: Get latest tag
         id: get_latest_tag
         uses: actions-ecosystem/action-get-latest-tag@v1
+        with:
+          initial_version: 'v${{ steps.extract_version.outputs.version }}'
 
       - name: See if version changed
         run: |
@@ -48,7 +50,7 @@ jobs:
         uses: softprops/action-gh-release@v1
         with:
           tag_name: 'v${{ steps.extract_version.outputs.version }}'
-          generate_release_notes: 1
+          generate_release_notes: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

CHANGELOG.md

@@ -5,7 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [3.1.0] - 2023-02-17
+
+### Added
+
+- Node version minimal requirements upgraded from 12.x to 14.x.
+- Upgraded aws-sdk, eslint, mocha, serverless, typescript and some other packages.
+- npm bin changed to npx because of first command's deprecation.
+
+## [3.0.2] - 2023-02-09
+
+### Added
+
+- Github workflow adjustment
+
+## [3.0.1] - 2022-02-28
+
+### Added
+
+- Fixes for build
 
 ## [3.0.0] - 2022-02-03
 

README.md

@@ -59,22 +59,41 @@ functions:
 ```
 
 ## Running Tests
+To run unit tests:
+```
+npm run test
+```
 
-To run the test:
-
-```shell
-npm test
+For running integration tests you will need to log into you AWS account 
+and set AWS_PROFILE environment variable, 
+it will be used to create AWS entities for testing purposes
 ```
+export AWS_PROFILE=<profile_name>
 
-All tests should pass.
+npm run integration-test
+```
 
-If there is an error update the node_module inside the serverless-log-forwarding folder:
+All tests should pass. All unit tests should pass before merging.
+Integration tests will probably take some time
 
-```shell
+If there is an error update the node_modules inside the root folder of the directory:
+```
 npm install
 ```
 
+## Writing Integration Tests
+Unit tests are found in `test/unit-tests`. 
+Integration tests are found in `test/integration-tests`. 
+
+`test/integration-tests` contains configs folder, 
+for every test there is a folder with `serverless.yml` configuration and `logs_producer.py`.
+
+To add another test create a folder for your test with the folder name that corresponds to test name
+and add code to run test to `test/integration-tests/integration-tests.ts`
+
+
 ## Deploying
+
 ---------
 The plugin will be packaged with the lambda when deployed as normal using Serverless: