Developing for openIDL
openIDL is an open source project. We will follow best practices for such projects.
the branches are:
- main - protected branch from which the UAT and Production builds are sourced
- test - protected branch from which the integration test environment is built
- dev - each developer has their own branch which may correspond to a cloud account
pull requests are used to promote from dev to test and from test to main
github actions are used to build, run unit tests, and deploy to the environment
README.md files provide help in. understanding each sub project and how to test it locally
the repository is a monorepo. It holds all the different components in subdirectories. Each one can be built and tested separately.
common components are developed following this process:
| Info | ||
|---|---|---|
| ||
Development on Local MachineCreate a branch make update to the common code make dependency from dependent code as relative path run tests commit to branch in git Testing with Dependent Appsidentify all apps that are dependent and should be updated for each we need to test them pull the changed common component code use relative path dependency run tests Deploying as Packageupdate version of common lib package.json pull request merge into main CI/CD auto deploys new version to github packages Update and retest dependentsfor each dependent including original app that drove the change update package.json to use the versioned dependency rerun tests commit and push updates to dependent app pull request merge CI/CD auto whatever |
DevOps Diagram
Here we discuss the DevOps for openIDL.
...