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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for documents in separate projects, status filters and text work items #106

Merged
merged 14 commits into from
Sep 4, 2024

Conversation

micha91
Copy link
Collaborator

@micha91 micha91 commented Sep 3, 2024

In this PR the following additional Features will be added:

  • Documents can now be placed in a different project than the model sync work items
  • You can define a list of document statuses which you want to allow document updates in
  • It is now possible to define text work items in a document
    • A text work item can be defined in the document template by using the workitem tag: <workitem id="id">Some text</workitem>
    • The defined ID must be unique in the document
    • The ID will be stored in a custom field of the work item in polarion
    • By default the type of these workitems is text and the ID will be stored in custom field __C2P__id
    • You can overwrite this in the config by setting the text_work_item_type and text_work_item_id_field parameters in your config:
  - template_directory: jupyter-notebooks/document_templates
    sections:
      section1: test-icd.html.j2
      section2: test-icd.html.j2
    text_work_item_type: myType
    text_work_item_id_field: myId
    instances:
      - polarion_space: _default
        polarion_name: id1234
        section_params:
          section1:
            param_1: Test

@micha91 micha91 marked this pull request as ready for review September 3, 2024 10:48
Copy link
Member

@ewuerger ewuerger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some things. After these I would give an approval.

capella2polarion/connectors/polarion_worker.py Outdated Show resolved Hide resolved
capella2polarion/connectors/polarion_worker.py Outdated Show resolved Hide resolved
capella2polarion/connectors/polarion_worker.py Outdated Show resolved Hide resolved
capella2polarion/connectors/polarion_worker.py Outdated Show resolved Hide resolved
capella2polarion/connectors/polarion_worker.py Outdated Show resolved Hide resolved
@micha91 micha91 changed the title Add document project support Add support for documents in separate projects, status filters and text work items Sep 4, 2024
Copy link
Member

@ewuerger ewuerger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

…rwise all runs with more than one work item to be deleted will fail
@micha91 micha91 merged commit b5a368f into main Sep 4, 2024
8 checks passed
@micha91 micha91 deleted the add-document-project-support branch September 4, 2024 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants