From 8a00e351a26ae59b16e6051430c525c80ccd2fcc Mon Sep 17 00:00:00 2001 From: MoritzWeber Date: Thu, 18 Jul 2024 10:50:28 +0200 Subject: [PATCH] docs: Use a clear name for the Polarion template Before, it was not clear which template to select in the list of templates. The template name or description didn't contain any reference to Capella or Capella2Polarion. In addition, it had a reference to "Deutsche Bahn", but the template can of cause also be used outside of Deutsche Bahn. --- .github/workflows/publish.yml | 38 +++++++++++++++++------------------ README.md | 35 +++++++++++++++++++------------- template/template.properties | 4 ++-- 3 files changed, 42 insertions(+), 35 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index f53509c..4423df9 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -12,22 +12,22 @@ jobs: publish-zip: runs-on: ubuntu-latest steps: - - name: Checkout repository - uses: actions/checkout@v3 - - name: Update Template Properties - run: | - sed -i "1s|.*|name=DBS MBSE Template Version ${{ github.ref_name }}|" template/template.properties - sed -i "2s|.*|description=Standard MBSE Template Project for Deutsche Bahn (DBS), $(date '+%d.%m.%Y')|" template/template.properties - - name: Zip Template Folder - run: | - mkdir ${{ vars.TEMPLATE_FILENAME }} && cp -r template/. ${{ vars.TEMPLATE_FILENAME }} - zip -r ${{ vars.TEMPLATE_FILENAME }}.zip ${{ vars.TEMPLATE_FILENAME }} - - name: Attach ZIP file to release - uses: shogo82148/actions-upload-release-asset@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - upload_url: ${{ github.event.release.upload_url }} - asset_path: ./${{ vars.TEMPLATE_FILENAME }}.zip - asset_name: ${{ vars.TEMPLATE_FILENAME }}.zip - asset_content_type: application/zip + - name: Checkout repository + uses: actions/checkout@v3 + - name: Update Template Properties + run: | + sed -i "1s|.*|name=Capella2Polarion Template Version ${{ github.ref_name }}|" template/template.properties + sed -i "2s|.*|description=Standard MBSE Template Project for Deutsche Bahn (DBS), $(date '+%d.%m.%Y')|" template/template.properties + - name: Zip Template Folder + run: | + mkdir ${{ vars.TEMPLATE_FILENAME }} && cp -r template/. ${{ vars.TEMPLATE_FILENAME }} + zip -r ${{ vars.TEMPLATE_FILENAME }}.zip ${{ vars.TEMPLATE_FILENAME }} + - name: Attach ZIP file to release + uses: shogo82148/actions-upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{ github.event.release.upload_url }} + asset_path: ./${{ vars.TEMPLATE_FILENAME }}.zip + asset_name: ${{ vars.TEMPLATE_FILENAME }}.zip + asset_content_type: application/zip diff --git a/README.md b/README.md index c337bf3..369a592 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,41 @@ -# Polarion Project Template +# Capella2Polarion Project Template + A Polarion project template with icons and predefined work item types, work item type links for Capella model objects. # How to use the template? -In the global administration you can find a ``Project Templates`` tab. There -under ``Custom Templates`` you are able to upload a ZIP file containing the + +In the global administration you can find a `Project Templates` tab. There +under `Custom Templates` you are able to upload a ZIP file containing the template. On creation of new projects you should be able to select the uploaded template. # Updating the template -This is achieved by the very same routine described under ``How to use the -template``. Take care that on modifying or deleting existing configurations has -critical effects on work items in projects which use this template. Changing -IDs of work item (link) types will corrupt existing work items. They need to be -patched to the corresponding modifications to the configuration. As this can be -a tedious task, it may be wise to do this via a migration script. + +This is achieved by the very same routine described under +`How to use the template`. Take care that on modifying or deleting existing +configurations has critical effects on work items in projects which use this +template. Changing IDs of work item (link) types will corrupt existing work +items. They need to be patched to the corresponding modifications to the +configuration. As this can be a tedious task, it may be wise to do this via a +migration script. # Global configuration + In the global folder there are individual XML enumeration files for configuring work items individually. For distinguishing these configuration files from -others a prefix (``_C2P``) has been used. The custom field XML files can be -generated from the [script](https://github.com/DSD-DBS/capella-polarion-template/blob/main/scripts/generate_custom_fields.py) +others a prefix (`_C2P`) has been used. The custom field XML files can be +generated from the +[script](https://github.com/DSD-DBS/capella-polarion-template/blob/main/scripts/generate_custom_fields.py) in the scripts folder. # Licenses -This project is compliant with the [REUSE Specification Version 3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md) +This project is compliant with the +[REUSE Specification Version 3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md) Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in [LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt)) @@ -36,5 +43,5 @@ Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in Dot-files are licensed under CC0-1.0 (see full text in [LICENSES/CC0-1.0.txt](LICENSES/Apache-2.0.txt)) -All GIF, PNG, JPEG or SVG files in the template are licensed under EPL-2.0 (see full text in -[LICENSES/EPL-2.0.txt](LICENSES/Apache-2.0.txt)) +All GIF, PNG, JPEG or SVG files in the template are licensed under EPL-2.0 (see +full text in [LICENSES/EPL-2.0.txt](LICENSES/Apache-2.0.txt)) diff --git a/template/template.properties b/template/template.properties index d136ec9..bab19a6 100644 --- a/template/template.properties +++ b/template/template.properties @@ -1,3 +1,3 @@ -name=DBS MBSE Template Version 1.0 -description=Standard MBSE Template Project for Deutsche Bahn (DBS), 21.07.2023 +name=Capella2Polarion Template Version X.X +description=Template for Capella2Polarion Sync-Projects in Polarion, %d.%m.%Y process=.polarion/tracker/fields/workitem-type-enum.xml