Skip to content

Commit

Permalink
Update PR_Template_VersionUpgrade.md (#463)
Browse files Browse the repository at this point in the history
* Update PR_Template_VersionUpgrade.md

* Update PR_Template_VersionUpgrade.md
  • Loading branch information
leslieber authored Oct 29, 2024
1 parent c193362 commit 102e6c2
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE/PR_Template_VersionUpgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,33 @@ Date:

## Description
<!--- CAVEAT: You to be an admin to perform all the necessary jobs. -->
This is a Pullreuqest that requires an increase in the Version number. Therefore, multiple outside-github, related Task have to be performed and checked.
This is a Pullrequest that requires an increase in the Version number. Therefore, multiple outside-github, related Task have to be performed and checked.

All jobs with an `x` in the boxes were performed to the best of knowledge.

## Pre-Merge Activities
<!--- Lets check everything before we continue. -->
- [ ] This PR refers to a versioned Branch with a name and a version number in the form of N.n.n, e.g. "TC_3.2.1".
- [ ] This PR has a clean meaningful commit history. Minor commits or commits without description have been squashed, at the latest now.
- [ ] The _./github/workflows/main.yml_ refers to the correct Firely Terminal and SUSHI Version.
> **_Firely Terminal Pipeline_** 0.4.0.
> **_SUSHI Versions_** 3.5.0.
- [ ] By running the _Release_Publish.py_ script, release version and date was updated accordingly. The script ran without errors.
- [ ] Eventually, increase the dependency of to newer Basis Modul (package and sushi-config)
- [ ] New Release Notes were created, alined to the commit history and cleaned. In Github, go to
- [ ] _-> Releases_ then _-> Draft a new release_ with the _Modul Name and Version_, then
- [ ] _-> Target the main-Branch_ and _->enter a new Tag according to the Version_, then click.
- [ ] Click _-> Generate Release notes_ , _->Adjust them if necessary_ and _-> Copy/Paste the Details in the RealeaseNotes.md_ of the very Branch you want to merge.
- [ ] Eventually, increase the dependency of to newer Basis Modul and Basispofil-de and possibly others (package json and sushi-config)
- [ ] Run Python script in terminal and increment version
- [ ] New Release Notes were created, alined to the commit history. Possibly, if you want to check the release notes for completeness, check against automatic relesase note generation in GitHub. In Github, go to
- [ ] _-> Releases_ then _-> Draft a new release_ with the _Modul Name and Version_, then
- [ ] _-> Target the main-Branch_ and _-> enter a new Tag according to the Version_, then click.
- [ ] Click _-> Generate Release notes_ , _-> Adjust them if necessary_ and _-> Copy/Paste the Details in the RealeaseNotes.md_ of the very Branch you want to merge.
- [ ] Finally _-> Save as Draft_

## Merge and Publishing
<!--- Now lets do the merge. -->
<!--- Include details of your testing environment, especially -->
- [ ] With the updated Version, Dates, and Release Notes (as described above) with the last committ into the Branch you want to merge.
- [ ] In GitHub _-> Actions_ the _->CI (FHIR Validation)_ workflow terminates successfully.
- [ ] In GitHub _-> Actions_ the _-> CI (FHIR Validation)_ workflow terminates successfully.
- [ ] Add the Approve / the PR gets positively reviewed by a colleague.
- [ ] Merge (without squash) the PR, delete the Branch.


## Post-Merge Activities
<!--- Do some update, refreshe and cleanup of related resources. -->
<!--- Do some update, refresh and cleanup of related resources. -->

- [ ] Go to the corresponding SIMPLIFIER Project and _-> Github -> Reimport_ the project.
- [ ] Go to the corresponding SIMPLIFIER Project and _-> Packages -> Expand the Dropdown for Create -> Create new package_ for the project.
Expand All @@ -46,10 +42,10 @@ All jobs with an `x` in the boxes were performed to the best of knowledge.
- [ ] Unlist the old package by _-> clicking on the old package_, _-> go to Administration_ and _-> click on Unlist_
- [ ] Publish the previously drafted Release, including version number, on GitHub.
- [ ] Provide / Archive the IG in the corresponding _gh-pages_ branch of the GitHub project.
- [ ] Checkout the Branch (no need to merge it later).
- [ ] Checkout the Branch (no need to merge it later).
- [ ] Export from Simplifier via _-> Guides -> Expand the Modul ... -> Export_
- [ ] Unpack the zip, remove the packages folder (because its kinda big), and move everything else to a (version corresponding) new folder in the branch folder structure.
- [ ] Update the file index.html and check rendering
- [ ] Update the file index.html and check rendering.
- [ ] commit the branch.
- [ ] If ISiK Basismodul was updated all depending Modules should be updated with a renewed dependency to the incremented Basismodul version - possibly including and closing technical corrections

Expand Down

0 comments on commit 102e6c2

Please sign in to comment.