commits
build(deps): bump docker/build-push-action from 6.10.0 to 6.11.0
Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 6.10.0 to 6.11.0.
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](https://github.com/docker/build-push-action/compare/48aba3b46d1b1fec4febb7c5d0c644b249a11355...b32b51a8eda65d6793cd0494a773d4f6bcef32dc)
---
updated-dependencies:
- dependency-name: docker/build-push-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
build(deps): bump docker/setup-buildx-action from 3.0.0 to 3.8.0
build(deps): bump sigstore/cosign-installer from 3.5.0 to 3.7.0
build(deps): bump docker/metadata-action from 5.0.0 to 5.6.1
build(deps): bump docker/login-action from 3.0.0 to 3.3.0
build(deps): bump docker/build-push-action from 5.0.0 to 6.10.0
Bumps [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action) from 3.0.0 to 3.8.0.
- [Release notes](https://github.com/docker/setup-buildx-action/releases)
- [Commits](https://github.com/docker/setup-buildx-action/compare/f95db51fddba0c2d1ec667646a06c2ce06100226...6524bf65af31da8d45b59e8c27de4bd072b392f5)
---
updated-dependencies:
- dependency-name: docker/setup-buildx-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [sigstore/cosign-installer](https://github.com/sigstore/cosign-installer) from 3.5.0 to 3.7.0.
- [Release notes](https://github.com/sigstore/cosign-installer/releases)
- [Commits](https://github.com/sigstore/cosign-installer/compare/59acb6260d9c0ba8f4a2f9d9b48431a222b68e20...dc72c7d5c4d10cd6bcb8cf6e3fd625a9e5e537da)
---
updated-dependencies:
- dependency-name: sigstore/cosign-installer
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [docker/metadata-action](https://github.com/docker/metadata-action) from 5.0.0 to 5.6.1.
- [Release notes](https://github.com/docker/metadata-action/releases)
- [Commits](https://github.com/docker/metadata-action/compare/96383f45573cb7f253c731d3b3ab81c87ef81934...369eb591f429131d6889c46b94e711f089e6ca96)
---
updated-dependencies:
- dependency-name: docker/metadata-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [docker/login-action](https://github.com/docker/login-action) from 3.0.0 to 3.3.0.
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](https://github.com/docker/login-action/compare/343f7c4344506bcbf9b4de18042ae17996df046d...9780b0c442fbb1117ed29e0efdff1e18412f7567)
---
updated-dependencies:
- dependency-name: docker/login-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 5.0.0 to 6.10.0.
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](https://github.com/docker/build-push-action/compare/0565240e2d4ab88bba5387d719585280857ece09...48aba3b46d1b1fec4febb7c5d0c644b249a11355)
---
updated-dependencies:
- dependency-name: docker/build-push-action
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
docs(README.md): update changelog with release 1.3.2 for improved logging
The changelog in the README.md is updated to include the new point release 1.3.2, which introduces improved logging. The version number in bm_monitor.py is incremented to 1.3.2 to align with the latest release, ensuring consistency across documentation and code.
Introduce logging to replace print statements, providing better control over log levels and output formatting. This change enhances the ability to monitor application behavior and debug issues. Add signal handling to ensure the application shuts down gracefully on receiving SIGINT or SIGTERM, which helps in resource management and prevents abrupt disconnections. These improvements aim to enhance the maintainability and reliability of the application.
Add comprehensive docstrings to the `push_pushover`, `push_dapnet`, `construct_message`, and `on_mqtt` functions. These docstrings provide detailed descriptions of each function's purpose, arguments, and return values, enhancing the readability and maintainability of the code. This change aims to assist developers in understanding the functionality and usage of these functions, facilitating easier future modifications and debugging.
feat(bm_monitor.py): add logging and graceful shutdown handling
Introduce logging to replace print statements, providing better control
over log levels and output formatting. This change enhances the ability
to debug and monitor the application by logging configuration details
and key events. Additionally, implement a signal handler to ensure
graceful shutdown on receiving SIGINT or SIGTERM, improving the
application's robustness and user experience.
Update the timestamp in the fly.toml configuration file comment to reflect the latest generation time. This change ensures that the file's metadata accurately represents the most recent configuration update, aiding in tracking and documentation.
Add a .dockerignore file to exclude unnecessary files and directories
from the Docker build context. This reduces the size of the context
sent to the Docker daemon, leading to faster build times and smaller
image sizes. The file is generated using a template for Flask, Python,
and Visual Studio Code projects, ensuring that common development
artifacts and environment-specific files are ignored.
Introduce a new GitHub Actions workflow to automate deployment
to Fly.io when changes are pushed to the main branch. This
enhances the deployment process by ensuring that the application
is automatically deployed to the Fly.io platform, improving
efficiency and reducing manual intervention. The workflow uses
the Fly.io CLI and requires a Fly API token stored in GitHub
secrets for authentication.
Introduce a new `fly.toml` configuration file to facilitate deployment
of the `bm-monitor` application on Fly.io. This file specifies the app
name, primary region, build settings, HTTP service configurations, and
virtual machine specifications. The addition of this file enables
streamlined deployment and management of the application on the Fly.io
platform, ensuring consistent environment settings and resource
allocation.
chore(sourcery.yaml): update configuration for Sourcery tool
Add 'config.ini' to the ignore list to prevent Sourcery from analyzing
this configuration file. Update GitHub settings to refine the review
process by specifying different reviewers for origin and forked
repositories. Remove specific labels and add 'documentation' and
'wontfix' to the ignore list to streamline the labeling process. These
changes aim to improve the configuration management and review workflow
for the project.
Chore/docker publish updates
Reorder the badges in the README to group related actions together.
The Docker Publish and CodeQL badges are now placed before the
Dependabot Updates badge, improving the logical flow and readability
of the document.
Add paths to the push and pull_request triggers to ensure the workflow runs when changes are made to the Dockerfile or bm_monitor.py. This change ensures that the Docker image is rebuilt and published whenever there are updates to these critical files, maintaining the integrity and up-to-date status of the Docker image.
docs(README.md): add GitHub Actions badges for CI/CD status visibility
Spaces are added between the badges in the README file to enhance
readability and visual clarity. This change makes it easier for users
to distinguish between different badges and their corresponding links.
ci: remove Docker Image CI workflow
Remove the Docker Image CI workflow to streamline the CI/CD process.
This change is made to reduce redundancy or because the Docker image
build process is no longer required in the GitHub Actions workflow.
This can help in optimizing the CI pipeline by removing unnecessary
steps, potentially reducing build times and resource usage.
Include badges for Dependabot Updates, Docker Publish, CodeQL, and Pylint
in the README to provide immediate visual feedback on the status of these
workflows. This enhances transparency and helps maintainers and contributors
quickly assess the health and status of the project's continuous integration
and delivery pipelines.
Update docker-publish.yml
Create docker-image.yml
docs: update README and installation-setup for clarity and formatting
Improve the clarity and readability of the documentation by updating
the origins section in README.md to better reflect the project's
history. Enhance the installation-setup.md by converting numbered
lists to a more readable format, adding notes for clarity, and
updating configuration instructions to reflect changes in the config
file format. These changes aim to make the documentation more
user-friendly and easier to follow, especially for new users setting
up the project for the first time.
build(Dockerfile): add Dockerfile for containerizing the application
Remove the DEBUG environment variable as it is not essential for the Dockerfile and can be set dynamically at runtime if needed. Replace CMD with ENTRYPOINT to ensure the Python script is executed as the main process of the container, providing better control over the container's lifecycle and allowing additional arguments to be passed if necessary.
Introduce a Dockerfile to enable containerization of the application.
This allows for consistent deployment across different environments.
The Dockerfile uses a slim Python 3.12 image to minimize the container size.
It sets up the working directory, installs dependencies from requirements.txt,
and copies the application code into the container. The DEBUG environment
variable is set to true for development purposes, and the container runs
the `bm_monitor.py` script by default.
Fix/requirements config
Add the configparser library to the requirements to handle configuration
files more effectively. This addition allows the application to read
and write configuration files, enhancing its configurability and
flexibility.
The config.ini file is added to .gitignore to ensure that any sensitive
information or environment-specific configurations contained within it
are not accidentally committed to the repository. This helps maintain
security and privacy by keeping such data out of version control.
chore: add CODEOWNERS file to define code ownership
Introduce a CODEOWNERS file to specify that all code is currently
owned by the user @mauvehed. This change helps in automatically
assigning reviewers for pull requests and ensures that the
appropriate person is notified for code reviews and changes.
Introduce a Dockerfile to enable containerization of the application.
This allows for consistent deployment across different environments.
The Dockerfile uses a slim Python 3.12 image to minimize the container size.
It sets up the working directory, installs dependencies from requirements.txt,
and copies the application code into the container. The DEBUG environment
variable is set to true for development purposes, and the container runs
the `bm_monitor.py` script by default.
Andy's usability changes for bm_monitor
build(deps): bump docker/build-push-action from 6.10.0 to 6.11.0
Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 6.10.0 to 6.11.0.
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](https://github.com/docker/build-push-action/compare/48aba3b46d1b1fec4febb7c5d0c644b249a11355...b32b51a8eda65d6793cd0494a773d4f6bcef32dc)
---
updated-dependencies:
- dependency-name: docker/build-push-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
build(deps): bump docker/setup-buildx-action from 3.0.0 to 3.8.0
Bumps [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action) from 3.0.0 to 3.8.0.
- [Release notes](https://github.com/docker/setup-buildx-action/releases)
- [Commits](https://github.com/docker/setup-buildx-action/compare/f95db51fddba0c2d1ec667646a06c2ce06100226...6524bf65af31da8d45b59e8c27de4bd072b392f5)
---
updated-dependencies:
- dependency-name: docker/setup-buildx-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [sigstore/cosign-installer](https://github.com/sigstore/cosign-installer) from 3.5.0 to 3.7.0.
- [Release notes](https://github.com/sigstore/cosign-installer/releases)
- [Commits](https://github.com/sigstore/cosign-installer/compare/59acb6260d9c0ba8f4a2f9d9b48431a222b68e20...dc72c7d5c4d10cd6bcb8cf6e3fd625a9e5e537da)
---
updated-dependencies:
- dependency-name: sigstore/cosign-installer
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [docker/metadata-action](https://github.com/docker/metadata-action) from 5.0.0 to 5.6.1.
- [Release notes](https://github.com/docker/metadata-action/releases)
- [Commits](https://github.com/docker/metadata-action/compare/96383f45573cb7f253c731d3b3ab81c87ef81934...369eb591f429131d6889c46b94e711f089e6ca96)
---
updated-dependencies:
- dependency-name: docker/metadata-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [docker/login-action](https://github.com/docker/login-action) from 3.0.0 to 3.3.0.
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](https://github.com/docker/login-action/compare/343f7c4344506bcbf9b4de18042ae17996df046d...9780b0c442fbb1117ed29e0efdff1e18412f7567)
---
updated-dependencies:
- dependency-name: docker/login-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 5.0.0 to 6.10.0.
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](https://github.com/docker/build-push-action/compare/0565240e2d4ab88bba5387d719585280857ece09...48aba3b46d1b1fec4febb7c5d0c644b249a11355)
---
updated-dependencies:
- dependency-name: docker/build-push-action
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
docs(README.md): update changelog with release 1.3.2 for improved logging
Introduce logging to replace print statements, providing better control over log levels and output formatting. This change enhances the ability to monitor application behavior and debug issues. Add signal handling to ensure the application shuts down gracefully on receiving SIGINT or SIGTERM, which helps in resource management and prevents abrupt disconnections. These improvements aim to enhance the maintainability and reliability of the application.
Add comprehensive docstrings to the `push_pushover`, `push_dapnet`, `construct_message`, and `on_mqtt` functions. These docstrings provide detailed descriptions of each function's purpose, arguments, and return values, enhancing the readability and maintainability of the code. This change aims to assist developers in understanding the functionality and usage of these functions, facilitating easier future modifications and debugging.
Introduce logging to replace print statements, providing better control
over log levels and output formatting. This change enhances the ability
to debug and monitor the application by logging configuration details
and key events. Additionally, implement a signal handler to ensure
graceful shutdown on receiving SIGINT or SIGTERM, improving the
application's robustness and user experience.
Add a .dockerignore file to exclude unnecessary files and directories
from the Docker build context. This reduces the size of the context
sent to the Docker daemon, leading to faster build times and smaller
image sizes. The file is generated using a template for Flask, Python,
and Visual Studio Code projects, ensuring that common development
artifacts and environment-specific files are ignored.
Introduce a new GitHub Actions workflow to automate deployment
to Fly.io when changes are pushed to the main branch. This
enhances the deployment process by ensuring that the application
is automatically deployed to the Fly.io platform, improving
efficiency and reducing manual intervention. The workflow uses
the Fly.io CLI and requires a Fly API token stored in GitHub
secrets for authentication.
Introduce a new `fly.toml` configuration file to facilitate deployment
of the `bm-monitor` application on Fly.io. This file specifies the app
name, primary region, build settings, HTTP service configurations, and
virtual machine specifications. The addition of this file enables
streamlined deployment and management of the application on the Fly.io
platform, ensuring consistent environment settings and resource
allocation.
Add 'config.ini' to the ignore list to prevent Sourcery from analyzing
this configuration file. Update GitHub settings to refine the review
process by specifying different reviewers for origin and forked
repositories. Remove specific labels and add 'documentation' and
'wontfix' to the ignore list to streamline the labeling process. These
changes aim to improve the configuration management and review workflow
for the project.
Add paths to the push and pull_request triggers to ensure the workflow runs when changes are made to the Dockerfile or bm_monitor.py. This change ensures that the Docker image is rebuilt and published whenever there are updates to these critical files, maintaining the integrity and up-to-date status of the Docker image.
Remove the Docker Image CI workflow to streamline the CI/CD process.
This change is made to reduce redundancy or because the Docker image
build process is no longer required in the GitHub Actions workflow.
This can help in optimizing the CI pipeline by removing unnecessary
steps, potentially reducing build times and resource usage.
Include badges for Dependabot Updates, Docker Publish, CodeQL, and Pylint
in the README to provide immediate visual feedback on the status of these
workflows. This enhances transparency and helps maintainers and contributors
quickly assess the health and status of the project's continuous integration
and delivery pipelines.
Update docker-publish.yml
Improve the clarity and readability of the documentation by updating
the origins section in README.md to better reflect the project's
history. Enhance the installation-setup.md by converting numbered
lists to a more readable format, adding notes for clarity, and
updating configuration instructions to reflect changes in the config
file format. These changes aim to make the documentation more
user-friendly and easier to follow, especially for new users setting
up the project for the first time.
Remove the DEBUG environment variable as it is not essential for the Dockerfile and can be set dynamically at runtime if needed. Replace CMD with ENTRYPOINT to ensure the Python script is executed as the main process of the container, providing better control over the container's lifecycle and allowing additional arguments to be passed if necessary.
Introduce a Dockerfile to enable containerization of the application.
This allows for consistent deployment across different environments.
The Dockerfile uses a slim Python 3.12 image to minimize the container size.
It sets up the working directory, installs dependencies from requirements.txt,
and copies the application code into the container. The DEBUG environment
variable is set to true for development purposes, and the container runs
the `bm_monitor.py` script by default.
Introduce a Dockerfile to enable containerization of the application.
This allows for consistent deployment across different environments.
The Dockerfile uses a slim Python 3.12 image to minimize the container size.
It sets up the working directory, installs dependencies from requirements.txt,
and copies the application code into the container. The DEBUG environment
variable is set to true for development purposes, and the container runs
the `bm_monitor.py` script by default.