adobe / adobe/aepsdk-commons

Enhance version.py

Open
#95 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
3
Forks
13
Avg merge
6m
Merged PRs (30d)
1

Description

Enhancement ideas:
1. Split the GitHub Actions annotation logging feature out of versions.py and make it a separate module available to other scripts too
2. Add strictly increasing version validation for update mode
3. For the version validation error case, inject more context into the annotated error message
1. Create a running fail message that can be injected into the final annotated error message
2. Also use the line-by-line logic to track which particular line in the file being validated failed
* For context, the script does provide granular error information per file, but this is not surfaced to the annotated error message that shows up in the GitHub Actions run overview

### Expected Behaviour

### Actual Behaviour

### Reproduce Scenario (including but not limited to)

#### Steps to Reproduce

#### Platform and Version

#### Sample Code that illustrates the problem

#### Logs taken while reproducing problem

Contributor guide

Open the contributing guide

Research direction

Start by reviewing version.py and the existing versions.py logic, focusing on GitHub Actions annotation logging and version validation. Break the requested enhancements into separate changes: reusable annotation logging, strictly increasing update-mode validation, and more contextual per-file error annotations. Done means the selected behaviors are implemented and validated by the relevant existing checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.