[REPOSITORY] New Repository for developer dojo

[mandy-chessell]

Name

egeria-dojo-developer

Owner

mandy-chessell

Deliverable

Provides the starting project structure for the developer dojo. The particupant creates a clone of it and works from there - they do not merge their code back into the repository. There is also a branch which includes the sample answers that they cna refer to if they get stuck.

Build, test and CI-CD process

This repository will use gradle. It is written in Java. Both the main branch and the worked examples will build and so a build can be part of the PR process. The worked examples will run in an OMAGServerPlatform. There is no need to release/publish to maven central.

The changes made to this repository will be maintenance on the dojo content rather than participants answers.

Dependencies

Need egeria.git in dependencies to build (plus normal egeria dependencies such as Kafka). Need OMAGServerPlatform to run.

Justification

The current developer dojo uses maven and we want to shift it to gradle for 2 reasons:

• The rest of the project is moving to gradle
• It avoids the maven install at the start of the dojo if we use the gradle wrapper

The current developer dojo has the participant install maven before they begin. They cut/paste code and pom files from the dojo description in egeria-docs. It has the following problems:

• Its a bit tedious - and will bet worse if they also have to cut/paste gradle wrapper etc
• There is no way to run and test the dojo code with each release without doing the dojo itself
• There are no worked examples that they can run/test - this has been a repeated request.

This new repository will create a more useful starting point for the developer dojo.

Assumptions

Agreed

Additional Information

When this repo is available the developer dojo will be rewritten to use it.

Work Plan

Before creating the repo

• [x] review overall request & get clarifications
• [x] get approval on developer/TSC call from maintainers

Creating the repo

• [x] Create the repo under the odpi organization (default gitignore, license, readme)
• [ ] Setup branch protection rules
• [ ] Set pull request options (allow merge, squash, rebase, suggest updating, allow automerge, do not delete head)
• [ ] Update security settings in repo (policy, advisories, alerts)
• [ ] set up permissions

First steps

• [ ] Initial code-drop (author)

Getting CI/CD started & refining settings

• [ ] Add initial build script for PR (including gradle wrapper if required)
• [ ] Add initial build script for merge

Further Refinement

• [ ] Add link in egeria docs to new repo describing purpose ( https://github.com/odpi/egeria-docs/blob/main/site/docs/education/tutorials/git-and-git-hub-tutorial/egeria-git-repositories.md )
• [ ] Add to connector catalog, if new repo is for connector ( https://github.com/odpi/egeria-docs/blob/main/site/docs/connectors/index.md )
• [ ] Add to release process docs ( https://github.com/odpi/egeria-docs/blob/main/site/docs/guides/contributor/release-process/index.md )
• [ ] Add required credentials for publishing to container repos, maven central etc
• [ ] Add artifact signing if needed
• [ ] Add dependabot config
• [ ] Add CodeQL
• [ ] Add to LFX ( https://projectadmin.lfx.linuxfoundation.org/project/a092M00001IV4JtQAL ) for
  • [ ] LFXSecurity
  • [ ] LFAnalytics
• [ ] Add check for stale defects
• [ ] Add any required issue tags

Release

• [ ] Add release pipeline

[planetf1]

When creating a repository, we can mark it as a template.

Currently we have one that I use for creating new connector repos (java) - as it saves time, but I believe other projects use them in a similar way to which you describe - for helping people get started with some work

See https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository

This seems more appropriate than a fork/clone which implies an intent to contribute back.

[planetf1]

@mandy-chessell I've created the initial template, but not from our example connector repo, as I think this is quite different (and is going to be > 1 module, and there's no publishing).

Do you want to start on the initial code setup, and then I can refine the checks/processes/gradle?

For a multi-module gradle build the egeria-database-connnectors repo is a simple example, whilst egeria itself is a large repo

[planetf1]

@mandy-chessell I think the steps required for your work are done, but assigning to you to close in case any of the ticklist items you feel need doing.