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

Integration of Connector and Events Lib #53

Open
DomiKoch opened this issue Jun 19, 2023 · 6 comments
Open

Integration of Connector and Events Lib #53

DomiKoch opened this issue Jun 19, 2023 · 6 comments
Assignees
Labels
enhancement New feature or request

Comments

@DomiKoch
Copy link
Collaborator

Description

Hi @Mhera17 ,

in the past you changed the integrated build of the connector and eventslib.
#22

With our repositories https://github.com/trustedshops-public/connect-app-eventslib and https://github.com/trustedshops-public/connect-app-connector now publicly available, we changed our deployment to release packages with versioning.

We want to adapt this in our NewGen Demo App.

Aim:
1a. Integrate the build of eventslib and connector directly from the release package
1b. we need to find a method to identify the version of build implemented in demo app (Do you have any idea where to put this information?)
2. Create a release package of demo app (version 1.0.0)

Keep in mind:
In future we want/you need to manually create a new version of the demo app, when there are breaking changes in Connector Layer or Eventslib. External developer need to comprehend the used build and changes

Greetings

References

No response

@DomiKoch DomiKoch added the enhancement New feature or request label Jun 19, 2023
@Mhera17
Copy link
Contributor

Mhera17 commented Jun 22, 2023

hi @DomiKoch. I updated the demo and added the 1.0.0 tag.
Sorry, I'm not sure I understand 1b clearly. Do I need to show the version in the UI? or maybe have local in source code (e.g. version.json, environment variable) or do we need to store this information on the backend side?

@DomiKoch
Copy link
Collaborator Author

DomiKoch commented Jun 22, 2023

Hi @Mhera17 ,

external developers should be able to identify the build version inside the code.

For Example:
At the moment inside the demo app is integrated:
Connector Script 1.0.0
Eventslib 1.0.0

This is a demo app release: 1.0.0

In the future we maybe will update the connector to 1.0.1. These changes will not be integrated all the time in the demo app. But when we update connector/and or Eventslib with new features and or products, we maybe want to update the demo app as well. For example Connector 1.4.0 is a new feature which we want to integrate in demo app as well. Then it would be:

Connector Script 1.4.0
Evetnslib 1.0.0

Demo App: 1.1.0 (only an example)

But we think it is necessary, that a developer can look insight the code and see, which version of connector and eventslib is integrated. First thought on our side was to name the scriptwith version, but then of course the code need to be adapted to the naming.
image

Maybe you have other ideas.

Greetings

@eburck
Copy link
Collaborator

eburck commented Jun 22, 2023

Hi @Mhera17 , we want to be transparent to a develeoper using demo app as blueprint for a plugin development which versions of connector/eventsLib is being used. What would you from a developer perspective like to see/expect?

@Mhera17
Copy link
Contributor

Mhera17 commented Jun 23, 2023

HI @eburck @DomiKoch.
Maybe it makes sense to have a separate branch on the git for each version of the demo, and then the developer will be able to switch locally.
but in this case, you need to find out how to deploy it

@Mhera17
Copy link
Contributor

Mhera17 commented Jun 28, 2023

Hi @eburck @DomiKoch .
What if we publish our two libs to NPM as separate packages every time we have a new version(this will be a lot easier as we have semantic versioning now),
by having npm packages we can install them directly in demo app, and it will be visible which version is currently running in demo app

@DomiKoch
Copy link
Collaborator Author

HI @eburck , could you look into this topic on monday?

Greetings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants