Skip to content

Conversation

mzuehlke
Copy link
Member

The updates.retraced section of the scala-steward.conf allows to declare updates that should be retracted. Each entry must have a reason, a doc URL and a list of dependency patterns.

Example:

updates.retracted = [
  {
    reason = "Ignore version 3.6.0 as it is abandoned due to broken compatibility",
    doc = "https://contributors.scala-lang.org/t/broken-scala-3-6-0-release/6792",
    artifacts = [
      { groupId = "org.scala-lang", artifactId = "scala3-compiler", version = { exact = "3.6.0" } }
    ]
  }
]

Retraction of Pull Request is only possible, if the workspace is persisted correctly. (https://github.com/scala-steward-org/scala-steward/blob/main/docs/faq.md#why-doesnt-self-hosted-scala-steward-close-obsolete-prs)

Fixes: #3445

@mzuehlke mzuehlke added the enhancement New feature or request label Nov 24, 2024
The `updates.retraced` section of the `scala-steward.conf` allows to declare updates that should be retracted. Each entry must have a `reason, a `doc` URL and a list of dependency patterns.

Example:
```
updates.retracted = [
  {
    reason = "Ignore version 3.6.0 as it is abandoned due to broken compatibility",
    doc = "https://contributors.scala-lang.org/t/broken-scala-3-6-0-release/6792",
    artifacts = [
      { groupId = "org.scala-lang", artifactId = "scala3-compiler", version = { exact = "3.6.0" } }
    ]
  }
]
```
Retraction of Pull Request is only possible, if the workspace is persisted correctly. (https://github.com/scala-steward-org/scala-steward/blob/main/docs/faq.md#why-doesnt-self-hosted-scala-steward-close-obsolete-prs)

Fixes: #3445
Copy link

codecov bot commented Nov 24, 2024

Codecov Report

Attention: Patch coverage is 37.50000% with 20 lines in your changes missing coverage. Please review.

Project coverage is 89.67%. Comparing base (916c6a1) to head (65dfdc8).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
...ala/org/scalasteward/core/nurture/NurtureAlg.scala 0.00% 12 Missing ⚠️
...org/scalasteward/core/application/StewardAlg.scala 0.00% 6 Missing ⚠️
...lasteward/core/nurture/PullRequestRepository.scala 87.50% 1 Missing ⚠️
...alasteward/core/repoconfig/RetractedArtifact.scala 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3488      +/-   ##
==========================================
- Coverage   90.07%   89.67%   -0.41%     
==========================================
  Files         170      171       +1     
  Lines        3497     3526      +29     
  Branches      320      357      +37     
==========================================
+ Hits         3150     3162      +12     
- Misses        347      364      +17     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mzuehlke mzuehlke requested review from alejandrohdezma, exoego and fthomas and removed request for fthomas November 29, 2024 08:25
@mzuehlke mzuehlke merged commit dce40bb into main Dec 3, 2024
10 checks passed
@mzuehlke mzuehlke deleted the retraction branch December 3, 2024 18:04
@mzuehlke mzuehlke added this to the 0.31.2 milestone Dec 3, 2024
@SethTisue
Copy link
Contributor

outstanding, thank you for this!!

I'm eager to help publicize it once it's deployed (it's not deployed yet is it?)

@SethTisue
Copy link
Contributor

SethTisue commented Dec 4, 2024

oh, a thought just occurred to me... and I hate to suggest it so late... suppose a Steward PR gets merged, but the version in question is retracted afterwards. Will the steward leave a comment on the merged PR to notify the maintainers?

@mzuehlke
Copy link
Member Author

mzuehlke commented Dec 4, 2024

I haven't rolled this into a released, yet.
But wanted to do this later today.

Sadly I only went for the simpler option. All PRs that are still open will get closed with a comment. Otherwise I would have to keep book which closed PR did already got a retraction comment.

@mzuehlke
Copy link
Member Author

mzuehlke commented Dec 5, 2024

  1. Update scala3-library, ... to 3.6.0 gemini-hlsw/refined-algebra#95
  2. Update scala3-library, ... to 3.6.0 gemini-hlsw/lucuma-core#957

The 1st was closed, the 2nd got a comment even though is was already closed. Maybe the local state of Steward wasn't updated. For this use case even better.

Copy link
Member

@fthomas fthomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! I like that it so neatly fits into the application.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Closing pull-requests for retracted versions

3 participants