Skip to content

feat(jte): Add explanation about removal of developers section#789

Merged
gounthar merged 5 commits into
jenkins-infra:mainfrom
gounthar:add-explanation
Feb 11, 2025
Merged

feat(jte): Add explanation about removal of developers section#789
gounthar merged 5 commits into
jenkins-infra:mainfrom
gounthar:add-explanation

Conversation

@gounthar
Copy link
Copy Markdown
Collaborator

@gounthar gounthar commented Feb 10, 2025

Fixes #788. I would have loved to work with partial templates so we can reuse them in different contexts, but I failed with @include and @template. 🤷

Add explanation for removing developers section when applying UpgradeNextMajorParentVersion recipe.

  • New Partial Template:
    • Add plugin-modernizer-core/src/main/jte/partials/remove-developers-tag.jte to include common text about the removal of the developers tag.
  • Update PR Body for RemoveDevelopersTag:
    • Modify plugin-modernizer-core/src/main/jte/pr-body-RemoveDevelopersTag.jte to include the new partial template using the include directive.
  • Update PR Body for UpgradeNextMajorParentVersion:
    • Modify plugin-modernizer-core/src/main/jte/pr-body-UpgradeNextMajorParentVersion.jte to include the new partial template using the include directive.

Testing done

java -jar plugin-modernizer-cli/target/jenkins-plugin-modernizer-999999-SNAPSHOT.jar run --plugins test-results-analyzer --recipe UpgradeNextMajorParentVersion which leads to jenkinsci/log-parser-plugin#153 .

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

Add explanation for removing `developers` section when applying `UpgradeNextMajorParentVersion` recipe.

* **New Partial Template:**
  - Add `plugin-modernizer-core/src/main/jte/partials/remove-developers-tag.jte` to include common text about the removal of the `developers` tag.
* **Update PR Body for `RemoveDevelopersTag`:**
  - Modify `plugin-modernizer-core/src/main/jte/pr-body-RemoveDevelopersTag.jte` to include the new partial template using the `include` directive.
* **Update PR Body for `UpgradeNextMajorParentVersion`:**
  - Modify `plugin-modernizer-core/src/main/jte/pr-body-UpgradeNextMajorParentVersion.jte` to include the new partial template using the `include` directive.
Add explanation for removing `developers` section when applying `UpgradeNextMajorParentVersion` recipe.

* **New Partial Template:**
  - Add `plugin-modernizer-core/src/main/jte/partials/remove-developers-tag.jte` to include common text about the removal of the `developers` tag.
* **Update PR Body for `RemoveDevelopersTag`:**
  - Modify `plugin-modernizer-core/src/main/jte/pr-body-RemoveDevelopersTag.jte` to include the new partial template using the `include` directive.
* **Update PR Body for `UpgradeNextMajorParentVersion`:**
  - Modify `plugin-modernizer-core/src/main/jte/pr-body-UpgradeNextMajorParentVersion.jte` to include the new partial template using the `include` directive.
@gounthar gounthar marked this pull request as ready for review February 11, 2025 10:41
@gounthar gounthar merged commit 3ea8af4 into jenkins-infra:main Feb 11, 2025
@gounthar gounthar deleted the add-explanation branch February 11, 2025 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an explanation about why the developers section got removed when applying the UpgradeNextMajorParentVersion

2 participants