Skip to content

Commit

Permalink
Merge branch 'main' into fix/dtrcontract_reusage
Browse files Browse the repository at this point in the history
# Conflicts:
#	charts/puris/Chart.yaml
#	charts/puris/README.md
  • Loading branch information
tom-rm-meyer-ISST committed May 24, 2024
2 parents 7fddfb0 + 138c358 commit b88aece
Show file tree
Hide file tree
Showing 70 changed files with 1,875 additions and 1,319 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/build-image-backend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,23 @@ jobs:
- name: Checkout
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6

# Copy legal information from root dir to backend dir for publishing

- name: Copy and paste legal information
run: |
cp ./DEPENDENCIES_BACKEND ./backend/DEPENDENCIES
cp ./LICENSE ./backend/LICENSE
cp ./NOTICE.md ./backend/NOTICE.md
cp ./SECURITY.md ./backend/SECURITY.md
# Needed to create multi-platfrom image
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0

# Needed to create multi-platfrom image
- name: Set up QEMU
uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3.0.0

# Create SemVer or ref tags dependent of trigger event
- name: Docker meta
id: meta
Expand Down Expand Up @@ -79,6 +96,7 @@ jobs:
with:
context: ./backend
file: ./backend/Dockerfile
platforms: linux/amd64, linux/arm64
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
Expand Down
44 changes: 43 additions & 1 deletion .github/workflows/build-image-frontend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,47 @@ jobs:
- name: Checkout
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6

- name: Setup Node
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version: 20
registry-url: https://registry.npmjs.org/

- name: Get npm version
id: npm-tag
uses: martinbeentjes/npm-get-version-action@3cf273023a0dda27efcd3164bdfb51908dd46a5b # v1.3.1

- name: Install Dependencies
working-directory: ./frontend
run: npm install

# Replace "about license" information
- name: Update legal notice
working-directory: ./frontend
run: bash ./scripts/legal-notice.sh

# Copy user guide to frontend dir for building
- name: Copy user guide
run: |
cp -r ./docs/user/img ./frontend/public
cp ./docs/user/User_Guide.md ./frontend/src/assets/User_Guide.md
- name: Build for Docker
working-directory: ./frontend
run: npm run dockerbuild

# Copy legal information from root dir to frontend dir for publishing
- name: Copy and paste legal information
run: |
cp ./DEPENDENCIES_FRONTEND ./frontend/DEPENDENCIES
cp ./LICENSE ./frontend/LICENSE
cp ./NOTICE.md ./frontend/NOTICE.md
cp ./SECURITY.md ./frontend/SECURITY.md
# Needed to create multi-platfrom image
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0

# Create SemVer or ref tags dependent of trigger event
- name: Docker meta
id: meta
Expand Down Expand Up @@ -78,7 +119,8 @@ jobs:
uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
with:
context: ./frontend
file: ./frontend/Dockerfile
file: ./frontend/Dockerfile.prebuilt
platforms: linux/amd64, linux/arm64
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
Expand Down
14 changes: 5 additions & 9 deletions .github/workflows/helm-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,21 +112,17 @@ jobs:
ct install --charts charts/puris --helm-extra-set-args "--set backend.image.repository=${{ env.REGISTRY }}/${{ env.APP_BACKEND_NAME}} --set backend.image.tag=${{ env.TAG }} --set frontend.image.repository=${{ env.REGISTRY }}/${{ env.APP_FRONTEND_NAME }} --set frontend.image.tag=${{ env.TAG }}"
if: github.event_name != 'pull_request' || steps.list-changed.outputs.changed == 'true'

- name: Generate random password (This password is only a placeholder for the next step and will not used).
id: generate-password
run: |
echo "PASSWORD=PLACEHOLDER_PW" >> $GITHUB_ENV
# Upgrade the released chart version with the locally available chart
# default value for event_name != workflow_dispatch
# Setting passwords during upgrade:
# - The postgresPassword/password will be set via postgres-init.yaml.
# - The dtr.idp.clients.edc.puris.secret is new and needs to be set during upgrade as not set in previous version
# - set existing secret to value currently defaulted
# - insert password to postgres directly due to empty default for reuse during upgrade
# https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues/#credential-errors-while-upgrading-chart-releases
- name: Run helm upgrade
run: |
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev
helm install puris tractusx-dev/puris --version ${{ github.event.inputs.upgrade_from || '1.0.0' }}
helm install puris tractusx-dev/puris --version ${{ github.event.inputs.upgrade_from || '1.0.0' }} --set postgresql.auth.existingSecret="secret-puris-postgres-init"
helm dependency update charts/puris
helm upgrade puris charts/puris --set backend.puris.datasource.password=$PASSWORD --set backend.puris.dtr.idp.clients.puris.secret=$PASSWORD
helm upgrade puris charts/puris
if: github.event_name != 'pull_request' || steps.list-changed.outputs.changed == 'true'
47 changes: 44 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v2.0.0](https://github.com/eclipse-tractusx/puris/releases/tag/v2.0.0)
## [v2.0.0](https://github.com/eclipse-tractusx/puris/releases/tag/2.0.0)

The following Changelog lists the changes. Please refer to the [documentation](docs/README.md) for configuration needs
and understanding the concept changes.
Expand Down Expand Up @@ -39,6 +39,7 @@ The **need for configuration updates** is **marked bold**.
- Added projection of stock from latest stock.
- Added possibility to pull data from partner for demand, planned production and deliveries.
- Catalog now uses partners and their EDC url (no freehand check possible anymore)
- Updated user guide and added it to the frontend (help feature)
- **Data Sovereignty**
- Added Membership Credential to all access policies.
- **Added Usage Purpose as mandatory for submodel.**
Expand Down Expand Up @@ -83,6 +84,11 @@ The **need for configuration updates** is **marked bold**.

### Known Knowns

#### Security

The Backend is currently secured via API Key while the Frontend already uses an API-KEY. See
[Admin Guide](./docs/admin/Admin_Guide.md) for further information.

#### Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.
Expand All @@ -100,9 +106,44 @@ For productive use the following enhancements are encouraged

#### Styleguide

To be checked
Overall

- Brief description at the top of each page describing content would be nice for better user experience.
- Please use different icon for Catalog, Negotiations, Transfers - currently all with
- Logout button does not work
- Logout button has trash symbol (**block**)
- Footer Component missing

Dashboard

- DropDown Headers / Field Headers not correctly placed. Other views / data entry / filter screens to be checked.
- Dashboard currently has larger fond than all other Page Headers -> please unify
- Create Demand - Day is mandatory and should require an asterix
- Create Demand - Upon entering data and closing, SOME (not all) entries are preserved (and so are warnings for
mandatory fields) --> upon closing and re-opening information should be reset to default. (**block**)
- Similar for Create Delivery (here SOME entries are reset but warnings stay) (**block**)

Stocks

- Switch between Material Stocks and Product Stocks -> same layout adaption as for Dashboard suggested (see above)
- Like the functionality that by clicking on a stock, data gets entered for add/update -> user needs better guidance to
do this (else error prone to enter one slightly different attribute and Add instead of update)
- Refresh -- update request has been sent successfully. -> more information regarding data transfer needed for user

Catalog

- Usage Policies are called "Asset Action"
- Header Name should be "View Connector Catalog" or "View Partner Catalog"
- No action possible -> unclear to user when and how user will consume an offer
- List shows a couple of items and item view takes up quite some space --> maybe use a table instead to show more items
in overview
- Delay in loading results and first "No Catalog available..." shown and then load items

Negotiations
- Similar as Catalog
- Add filters for transparency (bpnl, state)

## [v1.0.0](https://github.com/eclipse-tractusx/puris/releases/tag/v1.0.0)
## [v1.0.0](https://github.com/eclipse-tractusx/puris/releases/tag/1.0.0)

### Added

Expand Down
30 changes: 29 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The companies involved want to increase the automotive industry's
competitiveness, improve efficiency through industry-specific cooperation and
accelerate company processes through standardization and access to information
and data. A special focus is also on SMEs, whose active participation is of
central importance for the network’s success. That is why Catena-X has been
central importance for the network's success. That is why Catena-X has been
conceived from the outset as an open network with solutions ready for SMEs,
where these companies will be able to participate quickly and with little IT
infrastructure investment. Tractus-X is meant to be the PoC project of the
Expand Down Expand Up @@ -56,3 +56,31 @@ https://www.eclipse.org/projects/handbook/#resources-commit
Contact the project developers via the project's "dev" list.

* https://accounts.eclipse.org/mailing-list/tractusx-dev

## Hand's On PURIS!

To directly participate in the development of PURIS feel free to create an issue for Bugs or Features (User Story) in
repository.

You can also take over existing issues or just fix things directly in a pull request. To do so:

1. Create a fork (in tab `Code` of this repository on the right side, same row as repository name > click fork)
2. Clone your fork (copy commands for clone via green `Code` dropdown)
3. Checkout a new branch
4. Do the work.
- [Follow conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
- Checkout [development documentation](./docs/DEVELOPMENT.md) for frequent questions
- Checkout [Tractus-X Release Guidelines](https://eclipse-tractusx.github.io/docs/release) e.g., for open source
questions
- Run the tests and [local deployment](./local/INSTALL.md) (and refresh information in the view) to ensure you broke
nothing
5. Push your work and create a PR, best with linking to the issue via `#` and a meaningful description.
- Check that dependencies are up to date (if not done)
- Check and resolve pipeline results
- Request the review (if you're contributor)
6. Iterate over the code changes with the Committers!

> **Get in touch!**
>
> Checkout the [open meetings](https://eclipse-tractusx.github.io/community/open-meetings) to get in touch and find
> mentors and ask contributors on how things are done.
Loading

0 comments on commit b88aece

Please sign in to comment.