Skip to content

Commit

Permalink
docs: Use a clear name for the Polarion template
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
MoritzWeber0 committed Jul 18, 2024
1 parent ec8c357 commit 8a00e35
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 35 deletions.
38 changes: 19 additions & 19 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,47 @@
<!-- SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: Apache-2.0 -->

# 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))

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))
4 changes: 2 additions & 2 deletions template/template.properties
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8a00e35

Please sign in to comment.