Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version Deprecation Features in Coral #535

Open
1fanwang opened this issue Sep 23, 2024 · 0 comments · May be fixed by #536
Open

Version Deprecation Features in Coral #535

1fanwang opened this issue Sep 23, 2024 · 0 comments · May be fixed by #536
Assignees
Labels
help wanted Extra attention is needed

Comments

@1fanwang
Copy link
Collaborator

Background

Coral currently lacks a structured approach to version deprecation. This feature is needed to help drive new version adoption and allow developers to deprecate known breaking versions. This issue is related to the problems described in #534 , where unintended configuration overrides are causing authentication failures.

Objectives

  1. Implement a version deprecation system to encourage adoption of new versions.
  2. Allow developers to manually deprecate known breaking versions.
  3. Automate the deprecation process for older versions based on configurable criteria.

Proposed Features

1. Manual Deprecation

  • Ability for developers to deprecate specific versions through a GitHub Actions workflow.
  • Update GitHub release notes to mark deprecated versions.
  • Update Maven Central metadata (if applicable) to indicate deprecated versions.

2. Automatic Deprecation

  • Implement a scheduled task to automatically deprecate versions based on:
    • Age (e.g., versions older than 12 months)
    • Version difference (e.g., versions more than 10 minor versions behind the current release)
  • Allow configuration of deprecation criteria through GitHub Actions inputs.

Implementation Considerations

  • Create a separate GitHub Actions workflow for deprecation tasks.
  • Modify the build.gradle file to include deprecation-related tasks.
  • Ensure that the deprecation process doesn't interfere with the existing CI/CD pipeline.
  • Consider the impact on existing users and provide a grace period before full deprecation.
@1fanwang 1fanwang self-assigned this Sep 23, 2024
@1fanwang 1fanwang added the help wanted Extra attention is needed label Sep 23, 2024
@1fanwang 1fanwang linked a pull request Sep 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant