Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

[TRG 2.05] Add .tractusx repository metadata #36

Closed
FaGru3n opened this issue Jul 27, 2023 · 8 comments · Fixed by #37
Closed

[TRG 2.05] Add .tractusx repository metadata #36

FaGru3n opened this issue Jul 27, 2023 · 8 comments · Fixed by #37

Comments

@FaGru3n
Copy link
Contributor

FaGru3n commented Jul 27, 2023

In our release guideline 2.05 we describe a yaml metadata file that should be present for each of our repositories in eclipse-tractusx.

We are using this to automate several things across the GitHub org, like combining repos to a "Product view".
If the .tractusx metadata file is missing, we cannot show the repo in views like that

@tom-rm-meyer-ISST
Copy link
Contributor

We're currently deprecating the frontend and backend repository to merge the two repositories into one. This was our idea to incorporate this TRG.

Please find attached the PR.

We'll deprecate the separated repositories soon.

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Jul 27, 2023

@tom-rm-meyer-ISST Cool, thx for mentioning 👍🏼

Found a Hint for the PR eclipse-tractusx/puris#1

In the root of the TRG 2.04 - Leading product repository create a file called .tractusx:

currently for intit PR i found the .tractusx metafiles in each subfolder for front / backend

@tom-rm-meyer-ISST
Copy link
Contributor

@FaGru3n should we place an additional file into the root directory or just replace the separated ones by one in three root directory? I guess the second approach is correct, isn't it?

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Jul 28, 2023

Hi @tom-rm-meyer-ISST the root one on leading repo puris is the important one, when the backend and frontend repo will still exist and than also the underlying repos must have metafiles.

product: "PRODUCT_NAME"
leadingRepository: "LEADING_PRODUCT_REPOSITORY_URL"
repositories:
  - name: "REPOSITORY_1_NAME"
    usage: "DESCRIPTION/PURPOSE"
    url: "REPOSITORY_1_URL"
  - name: "REPOSITORY_2_NAME"
    usage: "DESCRIPTION/PURPOSE"
    url: "REPOSITORY_2_URL"

but when you afterwards just have one puris repo you have to describe it whats needed for backend and frontend for puris
and the metafile shoul look like:

product: "Puris"
leadingRepository: "https://github.com/eclipse-tractusx/puris"
repositories:
- name: "puris"
  usage: "Puris Frontend and Backend implementaion"
  url: "https://github.com/eclipse-tractusx/puris"

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Jul 28, 2023

@FaGru3n should we place an additional file into the root directory or just replace the separated ones by one in three root directory? I guess the second approach is correct, isn't it?

jep second approach.

@tom-rm-meyer-ISST
Copy link
Contributor

@FaGru3n Thanks a lot. I incorporated the second one in the initial contribution of the new puris repository. This repository will contain the frontend and backend.

We'll deprecate the frontend and backend within the next two weeks (after sucessfull IP check of the new repo). Is this sufficient or do we need to update the files accordingly?

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Jul 28, 2023

mhh i think the more of the work is allready done, less panic when starting releasing in august... 😄

i could also raise a PR against puris repo, because we are currently working on some more automisation against our ETX repos... so for that the metafile would be very helpful...

and this would also not conflict the current initial PR
eclipse-tractusx/puris#1

@tom-rm-meyer-ISST
Copy link
Contributor

Discussed it internally with @mhellmeier. We would love to postpone this as it creates some overhead for us and potentially for the eclipse foundation.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants