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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃帀 Release v2.2 馃帄 #39

Closed
8 tasks done
Potherca opened this issue Aug 6, 2022 · 10 comments
Closed
8 tasks done

馃帀 Release v2.2 馃帄 #39

Potherca opened this issue Aug 6, 2022 · 10 comments
Assignees
Milestone

Comments

@Potherca
Copy link
Member

Potherca commented Aug 6, 2022

Full Changelog: v2.1...v2.2

This issue is a placeholder for all tasks that need to be completed to release a new version (2.2.0):

  • Create a separate release/2-2 branch (as was done for previous releases).
    So users can include a versioned file instead of requring main / HEAD
  • Update the versioned links in the README.md file (see fe13039)
    So the documentation points to the latest available changes
  • Check if anything else that needs changing. Copyright year? Any contrib files? URLS? If so, add to the version branch.
    Making everything is in order before the release, so we do not have to make minor releases afterwards
  • Open an MR to incorporate the changes needed for version release into the main branch.
    So there is a fixed/traceable moment in time that marks the change
  • After review, merge the changes but DO NOT DELETE THE VERSION BRANCH. We want to keep that around.
    So users can include a versioned file instead of requring main / HEAD
  • Create a new release of the latest changes (using "Generate Release Notes").
    So there is a fixed/traceable moment in time that marks the change
  • Open an MR at plantuml/plantuml-stdlib
    So the latest changes are available to all users
  • Mark the version branch as protected
    So history cannot be falsified (whether by accident or on purpose).

It also serves to be a first step in documenting how releases are made. Eventually a complete write-up should be added as part of a CONTRIBUTING.md

@Potherca Potherca added this to the v2.2.0 milestone Aug 6, 2022
@Potherca Potherca self-assigned this Aug 6, 2022
@travisnielsen
Copy link
Contributor

travisnielsen commented Aug 27, 2022

I'd like to propose adding PlantUML theme support.

Comment moved to separate issue: #41

Original comment

I'd like to propose adding PlantUML theme support. This could be done by adding a themes directory to the dist folder and referencing it as follows:

@startuml theme-DefaultMonospacedFontName

!define AzurePuml https://raw.githubusercontent.com/travisnielsen/Azure-PlantUML/themesupport/dist

' IMPORT THEME HERE 馃憞馃徑
!includeurl AzurePuml/themes/blueprint.puml

!includeurl AzurePuml/Analytics/AzureEventHub.puml
!includeurl AzurePuml/Analytics/AzureStreamAnalyticsJob.puml
!includeurl AzurePuml/Databases/AzureCosmosDb.puml

left to right direction

agent "Device Simulator" as devices

AzureEventHub(fareDataEventHub, "Fare Data", "PK: Medallion HackLicense VendorId; 3 TUs", "testing 1234")
note right: this is a note
AzureEventHub(tripDataEventHub, "Trip Data", "PK: Medallion HackLicense VendorId; 3 TUs")
AzureStreamAnalyticsJob(streamAnalytics, "Stream Processing", "6 SUs")
AzureCosmosDb(outputCosmosDb, "Output Database", "1,000 RUs")

devices --> fareDataEventHub : "test arrow"
devices --> tripDataEventHub
fareDataEventHub --> streamAnalytics
tripDataEventHub --> streamAnalytics
streamAnalytics --> outputCosmosDb

@enduml

Blueprint
image

I have a proof-of-concept branch here: https://github.com/travisnielsen/Azure-PlantUML/tree/themesupport

A few other examples:

crt-green
image

reddress-darkblue
image

cerulean
image

@Potherca

This comment was marked as off-topic.

@travisnielsen
Copy link
Contributor

Makes sense. I'll create a separate issue for this so it can be linked to a future release.

@Potherca Potherca pinned this issue Sep 1, 2022
@npiper-deloitte
Copy link

+1 for a 2.2 release coming sooner rather than later, and notifying the Plantuml folk on support for it to include in their stdlib updates.

https://plantuml.com/stdlib

There's quite a few new Azure features / icons since 2.1 that can't be used for toolkits like Antora/Arc42 as Kroki doesn't support the !includeurl syntax and there are sometimes security restrictions on it.

See:
yuzutech/kroki#33

@travisnielsen
Copy link
Contributor

I have some time over the holiday break and am willing to create the pull request for version 2-2. I do have a question about the license. The current one is for 2018 with Ricardo Niepel's name. Is there any guidance on what this should be updated to? @Potherca - should the name be changed to you?

Also, I'm guessing that given the last round of changes from August are not part of a release, 2-2 will not include anything new beyond that...unless there's a fix needed. I can look at #43.

@Potherca
Copy link
Member Author

Potherca commented Dec 21, 2022

I have some time over the holiday break to! Lets get this release rolling!


Regarding the copyright, legally speaking all of these are valid, albeit with a slightly different meaning:

  • Copyright over a strict changeset, year over year:

    Copyright (c) 2018-2019, 2021-2022 Ricardo Niepel

  • Copyright over a loose changeset, years running:

    Copyright (c) 2018-2022 Ricardo Niepel

  • Copyright renewed each year :

    Copyright (c) 2022 Ricardo Niepel

I think the best would be to opt for:

Copyright (c) 2018-2019 Ricardo Niepel, 2021-2022 Ricardo Niepel and contributors

That way the contribution chain (and the implicit passing on of copyright) is most properly expressed.


If #43 isn't too large a fix, lets just roll it along with 2.2. 馃憤

@Potherca
Copy link
Member Author

Potherca commented Jan 2, 2023

Regarding

Mark the version branch as protected

I've setup a branch protection rule for release/* so all release branches are automatically protected against deletion. They could also be made read-only.

@Potherca
Copy link
Member Author

Potherca commented Jan 2, 2023

@Potherca Potherca closed this as completed Jan 2, 2023
@Potherca
Copy link
Member Author

Potherca commented Jan 2, 2023

Downstream merge-request has been opened: plantuml/plantuml-stdlib#68

@Potherca
Copy link
Member Author

Potherca commented Jan 2, 2023

Thank you to everyone involved in getting this released! 馃槏

Special thanks to @travisnielsen and @phatcher for doing the heavy lifting! 馃檶

And @npiper-deloitte and @PawelJanczyk-TomTom for reminding us there are real users waiting for this out there in the wild. Always good for motivation! 馃挭

@Potherca Potherca changed the title Release v2.2 馃帀 Release v2.2 馃帄 Jan 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants