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

chore(docs):[#223] Create concept for transfer to PCWM #701

Merged
merged 3 commits into from
Jan 19, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/concept/#223-Transfer-to-PCWM/#223-Transfer-to-PCWM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Transfer to Post-consortia-working-model (PCWM)

## How to migrate the Confluence pages to GitHub (Pages, Wiki, MD, issues)

It is possible to convert confluence html pages to markdown using this
tool: https://github.com/meridius/confluence-to-markdown
Unfortunately, the repository is archived, so it has to be validated, that it is still working.

[How-To: Export Confluence Space](https://confluence.atlassian.com/doc/export-content-to-word-pdf-html-and-xml-139475.html)

Migrating the confluence pages might also be a good time to get rid of outdated documentation.

## Test management and Test Reporting (Cucumber)

Cucumber Tests are were stored in and reported to Jira, using the Jira-Xray plugin.
ds-jhartmann marked this conversation as resolved.
Show resolved Hide resolved
ds-jhartmann marked this conversation as resolved.
Show resolved Hide resolved

Feature files can be exported and directly stored in GitHub.
ds-jhartmann marked this conversation as resolved.
Show resolved Hide resolved

Test results have to be displayed directly in GitHub workflow / Pull Request. This can be done in two ways:

- using the free [Cucumber Report Service](https://cucumber.io/docs/cucumber/reporting/?lang=java#cucumber-reports-service), where the results will be published to a cloud hosted service
- Using the generated test report and upload it using a GitHub Action https://github.com/marketplace/actions/publish-test-results

ds-jhartmann marked this conversation as resolved.
Show resolved Hide resolved
## Replacing the CatenaX-NG environment

The CatenaX-NG ArgoCD environments were used to execute Integration- and E2E-Tests. After the end of the Consortia phase, they are no longer available and have to be replaced by an open solution.
ds-jhartmann marked this conversation as resolved.
Show resolved Hide resolved

The proposed solution is a helm chart with all required dependencies, including EDC Consumer, EDC Provider, MIW,
ds-jhartmann marked this conversation as resolved.
Show resolved Hide resolved
Semantic Hub, Discovery Service, Digital Twin Registry, OAuth Provider and IRS. Implementation of this chart is planned
in https://github.com/eclipse-tractusx/item-relationship-service/issues/312

The chart will then be used in a GitHub workflow to test the E2E Workflow. The already existing Cucumber Tests can be
used.

Furthermore, integration tests using mocks of the third-party systems should be extended so testing can be done as much as possible on the local machine or in GitHub workflows, without setting up the entire helm deployment. This is planned in https://github.com/eclipse-tractusx/item-relationship-service/issues/344

## Change of development workflow

PRs are to be opened directly to eclipse-tractusx/item-relationship-service. Eclipse committers can create branches directly in this project. External contributors can contribute by forking the eclipse-tractusx/item-relationship-service project and create pull requests from their fork.

To be clarified:
- Should the non-committers of the core IRS team still use the catenax-ng/tx-item-relationship-service fork or create their own fork?
- Should we remove branch protection on catenax-ng/tx-item-relationship-service:main for easy synchronization with the upstream project?