Conversation
* workflows/update-gitignore #34 Updated .gitignore to allow .log files in the repository for test data. * workflow/add-gh-actions-workflow #34 Introduces a CI workflow that runs linting and tests on code changes to the main and dev branch, while skipping these steps for documentation-only changes. This setup uses flake8 for linting and pytest for testing, and optimizes CI runs by detecting code vs. docs changes.
…#42) * Add PR templates Introduces standardized pull request templates for bugfixes, code changes, documentation, CI/CD, and features in the .github/PR_TEMPLATES directory. These templates help ensure consistent and thorough PR descriptions, validation steps, and project checklists across different types of contributions. * Delete PULL_REQUEST_TEMPLATE.md #35 Deleted the .github/PULL_REQUEST_TEMPLATE.md file. This change removes the default template for new pull requests.
* Revamp README with clearer setup and feature guide #32 The README has been rewritten for clarity and conciseness, featuring a new quick start guide, clearer prerequisites, simplified command references, and improved documentation links. The overview, installation, and usage instructions are now more accessible, and advanced features are summarized with direct links to the Wiki. The new format is more user-friendly for first-time users and contributors. * Update README links and formatting #32 Corrected documentation and sample output links, updated the contributing guide URL, and improved formatting for the closing quote in the README. * Fix relative link to sample email report in README #32 Updated the link to the daily email report example to use the correct relative path, ensuring the documentation points to the right file location.
Enhanced the GitHub Actions workflow to better distinguish between code and documentation changes using separate path filters for pull requests and pushes. Updated the lint job to use Python 3.11 and ruff instead of flake8, and improved dependency installation for both lint and test jobs. The workflow now supports a fast path for documentation-only changes, skipping unnecessary jobs.
* Revise and expand contributing guidelines #33 Updated CONTRIBUTING.md with clearer, more structured quick-start instructions and recommendations. Added a new CONTRIBUTING_DETAILED.md file providing comprehensive workflow, commit signing, quality standards, and contribution requirements to help contributors follow best practices. * Fix relative links in contributing docs #33 Updated relative paths in CONTRIBUTING.md and CONTRIBUTING_DETAILED.md to ensure links to detailed guidelines and discussions work correctly. Closes #33
The man page for maillogsentinel was rewritten for clarity, brevity, and improved structure. Redundant and verbose sections were condensed, option descriptions were clarified, and auxiliary tool documentation was streamlined. The new version emphasizes practical usage, configuration, diagnostics, and security best practices, while removing excessive detail and outdated formatting.
Introduces a detailed FAQ (docs/wiki/FAQ.md) covering installation, configuration, usage, maintenance, integrations, troubleshooting, data analysis, security, and development for MailLogSentinel. This resource aims to assist users and contributors with common questions and operational guidance.
Introduces manual pages in Markdown format for the ipinfo, log_anonymizer, and maillogsentinel utilities. These documents provide usage instructions, options, configuration details, examples, and security considerations for each tool as part of the MailLogSentinel project.
Introduces a comprehensive installation and configuration guide for MailLogSentinel on Debian 12/13. The guide covers prerequisites, system preparation, installation steps, configuration, verification, service and timer setup, advanced options, troubleshooting, security, and additional resources.
monozoide
added
documentation
* Fix linting errors in CI workflow #58 This commit fixes a number of linting errors that were causing the CI workflow to fail. The errors were primarily related to unused imports, f-strings without placeholders, and unused variables. * Refactor and clean up test code #58 Removed unused imports and variables in test_maillogsentinel_setup.py and test_sql_exporter.py. Updated test_run_sql_export_basic_flow to use context manager for patching datetime and simplified the mocking of the logger. These changes improve test clarity and maintainability. * Remove duplicate unittest.mock import #58 Consolidated the import of patch and MagicMock from unittest.mock to avoid redundancy in the test file. * Remove unused MagicMock import #58 Cleaned up the import statements by removing MagicMock, which was not used in the test file.
github-project-automation
bot
moved this from In progress
to Done
in MailLogSentinel Roadmap
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔀 Merge dev → main: release v5.15.0
Merge Summary
This PR proposes merging the
devbranch intomainto deliver version v5.15.0 (see release notes). All changes since the last stable version have been developed and tested ondev.Release Highlights
🚀 New Features
ipinfoandlog_anonymizerutilities🛠️ Improvements
maillogsentinelmanual page🧪 Testing & Quality
👏 Contributions
🔗 View full changelog
Thank you for your review and feedback. The branch is ready to be merged into
main.