Class ChangeEntry

dev-tools/scripts/addDepsToChanges.py:35–124

Represents one dependency change entry. Fields: - pr_num: string PR number (e.g., '3605') - message: cleaned commit message text to be shown in CHANGES (noise removed) - author: Git author (e.g., 'solrbot')

class ChangeEntry:
    """
    Represents one dependency change entry.
    Fields:
      - pr_num: string PR number (e.g., '3605')
      - message: cleaned commit message text to be shown in CHANGES (noise removed)
      - author: Git author (e.g., 'solrbot')
    """

    def __init__(self, pr_num: str, message: str, author: str):
        self.pr_num = pr_num
        self.message = message
        self.author = author

    def dep_key(self) -> str:
        """
        Extract a dependency key from the message after 'Update ' and before ' to', '(' or end.
        This is used for de-duplication and sorting. Case-insensitive.
        """
        m = re.search(r"(?i)update\s+(.+?)(?:\s+to\b|\s*\(|$)", self.message)
        if m:
            return m.group(1).strip()
        return self.message.strip()

    def __str__(self) -> str:
        # Keep trailing newline to preserve existing blank-line formatting by update_changes
        return f"* PR#{self.pr_num}: {self.message} ({self.author})\n"

    def to_yaml_dict(self) -> dict:
        """
        Convert to a dictionary suitable for YAML serialization.
        Extracts JIRA IDs from the title and adds them to links.
        """
        # Extract JIRA IDs from the message
        title, jira_links = extract_jira_issues_from_title(self.message)

        # Build links: JIRA issues first, then PR
        links = jira_links.copy()  # Start with JIRA links
        links.append({
            'name': f'PR#{self.pr_num}',
            'url': f'https://github.com/apache/solr/pull/{self.pr_num}'
        })

        return {
            'title': title,
            'type': 'dependency_update',
            'authors': [
                {
                    'name': self.author
                }
            ],
            'links': links
        }

    def yaml_filename(self) -> str:
        """
        Generate a filesystem-safe filename for this entry.
        Format: PR#####-slug.yaml