Skip to content

v1.3.0

Latest
Latest
Compare
Choose a tag to compare
@EdFiBuildAgent EdFiBuildAgent released this 15 Jul 18:31
· 1 commit to main since this release
v1.3.0
9ada2fa
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Ed-Fi API Publisher Release Notes - Version 1.3.0

Overview

Version 1.3.0 of the Ed-Fi API Publisher includes significant functional improvements, bug fixes, and engineering enhancements focused on reliability, security, and developer experience.

Summary of Functional Updates

  • Bug Fixes: Fixed timeout issues with full min-max change version total count requests
  • Bug Fixes: Fixed issue where API Publisher wouldn't publish when only 1 change was made
  • Bug Fixes: Fixed exceptions being hidden when using remediation scripts
  • New Feature: Added authUrl argument for authentication URL configuration
  • New Feature: Added namespace support for change version tracking via lastChangeVersionProcessedNamespace option
  • Improvements: Enhanced dependencies URL extraction from API metadata with fallback support
  • Improvements: Enhanced logging context for different message producers
  • Security: Updated Docker base images and dependencies to address vulnerabilities
  • Documentation: Fixed documentation links and improved reverse paging documentation

Summary of Engineering Updates

Repository Infrastructure Enhancements

  • Dependency Management: Added automated dependency updates through GitHub Dependabot configuration
  • Project Organization: Enhanced project structure with improved build scripts and configuration files
  • Documentation: Added comprehensive documentation covering:
    • API connection management
    • Configuration options
    • Docker deployment considerations
    • Extensibility patterns
    • Known issues and remediation strategies
  • Security: Implemented security best practices including:
    • CODEOWNERS file for repository governance
    • Issue templates for structured reporting
    • Security policy documentation
  • Build System: Improved build automation with PowerShell scripts supporting multiple deployment targets

Developer Experience Improvements

  • Editor Configuration: Added consistent code formatting rules via .editorconfig
  • Issue Templates: Structured issue reporting with dedicated templates for engineering issues
  • Copilot Integration: Added GitHub Copilot instructions for enhanced development assistance
  • Docker Support: Enhanced Docker configuration with compose files and deployment templates

Changes in This Release

Commit Author Pull Request Description
9d2542b Stephen Fuqua #99 Create dependabot.yml - Added comprehensive repository infrastructure including CI/CD workflows, documentation, security policies, and automated dependency management
25c2d29 jagudelo-gap #97 Issue Management Template and Action Workflow - Added issue templates, updated workflow configurations, and detailed Copilot instructions
4cd13d0 dfernandez-gap #96 Changes in OnRelease Workflow to Delete Previous PreRelease Tags as well as GH Releases
3d264f9 jleiva-gap #95 Update openssl version for dockerfiles - Updated to version 3.3
a84e1ed jagudelo-gap #94 Fix the Step "Create API Publisher Pre-Release"
98c6f80 DavidJGapCR #93 Fixes documentation link on reverse paging
f30ef4e brian-pazos #92 Add authUrl argument and dependencies URL from metadata - Refactored to add authUrl argument and extract dependencies URL from metadata
9b0fcfd jpardogrowthaccelerationpartners #91 Update the deprecated packages
431baf7 DavidJGapCR #90 API Publisher some exceptions are hidden when using a remediation script
da17bee ea-mtenhoor #89 API Publisher some exceptions are hidden when using a remediation script
7e34787 ea-mtenhoor #88 Log correct context - Fixed issue where all MessageProducers were logging in the same context
4be38b6 ea-mtenhoor #87 Fix total count timeout and publishing with only 1 change - Fixed timeout issues and single change publishing problems
c0a5461 ea-mtenhoor #86 Add namespace to change version tracking - Added lastChangeVersionProcessedNamespace option for additional uniqueness
74814f5 jasonh-edfi #85 Update Reverse-Paging.md
f742485 jleiva-gap #84 Fixing vulnerabilities found with Docker Scout - Updated packages and Alpine version
ca01994 DavidJGapCR #83 Adds Sonar Analyzer - Log as json where appropriate
50559ff DavidJGapCR #82 Adds Sonar Analyzer - log web api metadata as a json format
c4cbd7c DavidJGapCR #81 Fixing Actions
fa51c2c DavidJGapCR #80 Adds Sonar Analyzer

Compatibility

This release maintains backward compatibility with version 1.2.1. While new features and bug fixes have been added, no breaking changes have been introduced. The new authUrl and lastChangeVersionProcessedNamespace options are optional and maintain existing behavior when not specified.

Installation and Upgrade

From Version 1.2.1

This release does not require any special upgrade procedures. Users can continue using existing configurations and deployment methods.

New Installations

Follow the standard installation procedures as documented in the README.md file.

Known Issues

No new known issues have been introduced in this release. For existing known issues, please refer to the Known Issues Details documentation.

Support

For support with the API Publisher, please use Ed-Fi Community Hub to open a support case and/or feature request.

Assets 4
Loading