Egeria lineage sample - add to connector catalog / release process

[davidradl]

Name

egeria-connector-integration-lineage-event-driven-sample

Owner

davidradl

Deliverable

Useful to bring in lineage to Egeria

Build, test and CI-CD process

usual

Dependencies

usual

Justification

in line with the thinking behind a new repo for egeria-connector-repository-file-sample we would like one for this sample. The samples repo is coco based

Assumptions

yes all true

Additional Information

No response

Work Plan

Before creating the repo

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

Creating the repo

• 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]

email sent to maintainer list in lieu of dev call as it would be useful to get this creation done soon.

[planetf1]

Agreed to create 20221116 TSC

[planetf1]

Started - updating template repository first, which will create the initial outline of this repo

[planetf1]

@davidradl I've done the initial repo setup.

• the code is still the sample (need something to get the actions in place) - you'll need to update
• search for 'TODO's to get pointers
• I've not setup any specific tags

Let me know if it looks ok. If so, will add the docs

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

[planetf1]

Moving to docs to ensure we've catalogued the repo there & in the lfx sites

[planetf1]

@juergenhemelt Can you handle this? This is just some missing docs -- documenting the connector in the connector catalog & documenting the release process.