Add README

update CHANGELOG
remove extra section of CI file

.gitlab-ci.yml

@@ -28,7 +28,13 @@ build:
     - .docker_base
   stage: build
   script:
-  - docker build --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA ./Docker/
+  - docker pull $CI_REGISTRY_IMAGE:latest || true
+  - >
+    docker build
+    --pull
+    --cache-from $CI_REGISTRY_IMAGE:latest
+    --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+    ./Docker/
   - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
 
 push local:
@@ -53,12 +59,12 @@ push dockerhub:
     CI_DOCKERHUB_IMAGE: index.docker.io/evanrich/py-eagle-mqtt
     CI_DOCKERHUB_REGISTRY: docker.io
   only:
-  - master
+  - tags
   script:
   - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
-  - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_DOCKERHUB_IMAGE:latest
+  - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_DOCKERHUB_IMAGE:$CI_COMMIT_REF_NAME $CI_DOCKERHUB_IMAGE:latest
   - docker login -u "$CI_DOCKERHUB_USER" -p "$CI_DOCKERHUB_PASSWORD" $CI_DOCKERHUB_REGISTRY
-  - docker push $CI_DOCKERHUB_IMAGE:latest
+  - docker push $CI_DOCKERHUB_IMAGE:$CI_COMMIT_REF_NAME $CI_DOCKERHUB_IMAGE:latest
   
 sast:
   stage: test

CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.6.9] - 2021-04-06
+
+### Fixed
+
+- Remove release-cli section of CI file
+- Add updated README.md
+
+## [1.6.8] - 2021-04-06
+
+### Changed
+
+- Fixed slight issue with tagging
+
+## [1.6.7] - 2021-04-06
+
+### Changed
+
+- Updated base image to Python 3.9.4-alpine3.13
+- Moved changes to this file
+
+### Removed
+
+- Changelog from README.md
+
+## [1.6.6] - 2021-04-03
+
+### Added
+
+- Added CI/CD pipeline to project
+
+### Changed
+
+- Moved project to my own personal Gitlab server for CI/CD pipelines as well as to run security scans on the container image and code
+
+- Updated base image to Python 3.9.3-alpine3.12
+
+## [Unversioned history]
+
+- 2019-07-24: Rebase to python 3.7.4-alpine3.10, update bottle to 0.12.17
+
+- 2019-04-12: Rebase to python 3.7.3-alpine3.9
+
+- 2019-03-08: Rebase to python 3.7.2-alpine3.9, update bottle and astral versions to latest
+
+- 2019-01-03: Rebase to python 3.7.2-alpine3.8, changed logging level to Info (should output to /var/log/tHome/eagle.log)
+
+- 2018-09-10: Ported to Python3, Added pricing info.  Merged into master branch

README.md

@@ -1,22 +1,11 @@
 # py-eagle-mqtt
 Python3 based Docker for Eagle to MQTT reader
 
-I have only ported this into a dockerfile, All Original code (with one minor modification for XML root tag) is credit to [Ted Drain - TD22057](https://github.com/TD22057/T-Home).
+I have only ported this into a dockerfile, as well as made some changes to code for security or other purposes. All Original code is credit to [Ted Drain - TD22057](https://github.com/TD22057/T-Home).
 
 ## UPDATES:
 
-2020-04-03: I've moved the repo to my private Gitlab server, with a mirror set up to github.  I did this so that I could easily integrate a CI/CD pipeline to build this image, as well as run some Security tools against the image to improve it's code quality.   Please continue to open bug reports/issues/pull requests here in Github.  Also swapped to defusedxml python module due to security issues around xmltree.  Forgot to incrememnt the build number, but docker container  latest is up-to-date.
-   
-2019-07-24: Rebase to python 3.7.4-alpine3.10, update bottle to 0.12.17
-
-2019-04-12: Rebase to python 3.7.3-alpine3.9
-
-2019-03-08: Rebase to python 3.7.2-alpine3.9, update bottle and astral versions to latest
-
-2019-01-03: Rebase to python 3.7.2-alpine3.8, changed logging level to Info (should output to /var/log/tHome/eagle.log)
-
-2018-09-10: Ported to Python3, Added pricing info.  Merged into master branch
-
+2020-04-06: Moved Updates to a CHANGELOG.md file to clean this up.
 
 ## Usage