Skip to content

[IDEA]: Add variables in the changelog, so that it becomes easier to manage it in each release #36

@matbmoser

Description

@matbmoser

Description

There is a cool feature from markdowns that is the "variables":

[VARIABLE]: content

When inserting it, you need to do this:

[VARIABLE]

Proposal

I would change all the urls from the changelog to a more easier structure:

<!-- START This part will not be visible --> 

<!--  Global Definitions  -->
[tx-repo]: https://github.com/eclipse-tractusx
[tag-prefix]: /releases/tag

<!-- Products  -->

<!-- IRS -->
[irs]: item-relationship-service
[irs-release-url]: [tx-repo][irs][tag-prefix]

<!-- DPP -->
[dpp]: digital-product-pass
[dpp-release-url]: [tx-repo][dpp][tag-prefix]

<!--END This part will not be visible --> 


## R24.08

<!-- START This part will not be visible --> 

<!-- IRS -->
[IRS-APP-R2408]: 7.1.3
[IRS-HELM-R2408]: item-relatinship-service-7.1.3

<!-- DPP -->
[DPP-APP-R2408]: v4.0.1
[DPP-HELM-R2408]: digital-product-pass-4.0.1 

<!--END This part will not be visible --> 

### Changelog 

| Product | Helm | App |
| :-- | :--: | :--: |
| [irs] |  [[IRS-HELM-R2408]]([irs-release-url]/[IRS-HELM-R2408]) | [[IRS-APP-R2408]]([irs-release-url]/[IRS-APP-R2408]) |
| [dpp] [[DPP-HELM-R2408]]([dpp-release-url]/[DPP-HELM-R2408]) | [[DPP-APP-R2408]]([dpp-release-url]/[IRS-APP-R2408]) |

## R24.05

<!-- START This part will not be visible --> 

<!-- IRS -->
[IRS-APP-R2405]: 5.1.0
[IRS-HELM-R2405]: item-relatinship-service-5.3.1

<!-- DPP -->
[DPP-APP-R2405]: 3.0.0
[DPP-HELM-R2405]: digital-product-pass-3.0.0 

<!--END This part will not be visible --> 

### Changelog

| Product | Helm | App |
| :-- | :--: | :--: |
| [irs] |  [[IRS-HELM-R2405]]([irs-release-url]/[IRS-HELM-R2405]) | [[IRS-APP-R2405]]([irs-release-url]/[IRS-APP-R2405]) |
| [dpp] [[DPP-HELM-R2405]]([dpp-release-url]/[DPP-HELM-R2405]) | [[DPP-APP-R2405]]([dpp-release-url]/[IRS-APP-R2405]) |

Acceptance Criteria

  • Variables are working as expected
  • Complexity is reduced

Examples:

In my repository I used some variables to define the urls in the footer:

https://github.com/eclipse-tractusx/digital-product-pass/blob/2ecd19b34b4f587101c0c2c8e5f7e3727ada6286/README.md?plain=1#L159-L168

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions