Skip to content

0.2.0

Latest
Latest
Compare
Choose a tag to compare
@en-ver en-ver released this 05 Jan 19:31
0.2.0
808f31e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

We are pleased to announce the latest version of the package, packed with significant updates designed to enhance performance, usability, and functionality. Below is a detailed breakdown of the key changes in this release:

1. Robust Validation for Reliable Operations

Integration of Pydantic Validation:
The package now leverages Pydantic validation to ensure all inputs adhere to expected formats, reducing the risk of unexpected crashes and improving overall reliability.

2. Optimized Field Handling

Performance Improvements for Field ID and Name Retrieval:
Methods for fetching field IDs and names have been refactored for enhanced performance.
Important Update:

  • The class no longer caches the most recent Jira response. Instead, each call initiates a fresh request to Jira.
  • Recommendation: If you need to fetch multiple field IDs or names, pass them as lists to perform bulk requests and minimize the number of API calls.

3. Enhanced Changelog Management

Field-Specific Changelogs:
Gain more precise insights by retrieving changelog entries for specific fields using the new fields parameter.

  • Pagination Support:
    Changelog methods now support pagination. You can either retrieve changes page by page or fetch all pages in one call, returning a consolidated list of all changelog items.

4. Standardized Input for Fields

Fields Now Require Lists:
Methods that take fields as input now require them to be passed as a list of strings. The previous approach of providing comma-separated strings is no longer supported. This change ensures consistency and simplifies input validation.

5. Improvements to the Issue Class

Persistent key_id Attribute:
The Issue class now requires a key_id parameter during initialization. This value is stored as an attribute, allowing seamless reuse across methods without the need to pass it repeatedly. This enhancement reduces redundancy and improves code clarity.

6. Overhauled JQL Search Functionality

  • Renaming and Enhanced Usability:
    The search functionality has been renamed to jql, aligning more closely with Jira's terminology and usage patterns.
  • Initialization with JQL Queries:
    The jql class now requires a JQL query string upon initialization.
  • Advanced Pagination Support:
    Just like the changelog enhancements, jql methods now allow you to fetch results page by page or retrieve all matching issues in a single consolidated list. This flexibility ensures efficient handling of large datasets.

Summary

This release represents a significant step forward in making the package more intuitive, efficient, and reliable. Key highlights include:

  • The introduction of robust input validation to prevent crashes.
  • Improved methods for handling Jira fields, changelogs, and JQL queries.
  • Standardized input formats for consistency.
  • Enhanced usability through persistent attributes and pagination support.

We encourage users to review the updated documentation to fully leverage the new features and adapt to any changes in parameter handling. We’re confident these updates will provide a smoother and more efficient experience.

Thank you for your continued support, and we look forward to your feedback on this release! 🚀

Assets 2
Loading