kbase/.github

KBase Developer Documentation

• KBase SDK Documentation

Core Service Docs

• Workspace: release, develop
  • Release KIDL spec, Develop KIDL spec
• Narrative UI
• KBase UI (non-narrative UI): release, develop
• Relation Engine: API, Specifications
• Search Engine: API, Indexer, Config
• Auth server
• File Caching Service
• ID mapping API
• Assembly homology API
• Service Wizard: KIDL spec
• Catalog: KIDL spec

Relation Engine and Search codebases

• The Relation Engine (using ArangoDB) can be found here: https://github.com/kbase/relation_engine
• The Search API (using Elasticsearch) is found here: github.com/kbase/search_api2/
• The Index Runner (which listens to Kafka events and imports data into Elasticsearch and ArangoDB) can be found here: https://github.com/kbase/index_runner

User help

• Using KBase
• User help board

.github's Issues

Feature Request

Manual build and push creates a label so you can tell which branch you kicked it off from

There is no `Include administrators` checkbox in the Github branch rules UI

https://github.com/kbase/.github/blob/main/guide/enable-branch-rules.md?plain=1#L57

Feature Request

• Automatically link the repo for the package
• Automatically make it public
• Automatically link the Actions access if thats required

Opening a PR to develop does not actually push as shown in the action description

E.g. for the action

The job does not actually push the image, which is confusing

Which is configured here, IIUC: https://github.com/kbase/collections/blob/main/.github/workflows/pr_build.yml#L17
I'm not sure where the misleading action name comes from

Feature Request

Add an echo statement that says "You can't build and push to ghcr.io for forks, please merge to inbox first"

Documentation

If Go to the repo and press the actions button

Press "New Workflow"

If you do not have any workflows, the UI will look like so

Press configure on each workflow you want to install

Final Steps

• Commit the file you want to a branch or to develop.
• It won't take full effect until it goes into the main/master branch
• You will not be able to create branch protections until the actions are pushed to the develop branch and the main/master branch.

Branch Protections

• Ask the maintainer of the repo to enable branch protections or do it if you have permissions
• They are identical for "main" and "develop" but a require you to specify the exact name of the github action. See below

Notice for Develop Branch Protections Action Name

Feature request

Add https://pypi.org/project/safety/ as an importable action?

Removed the dependency of curl command from the pr_build and production_release.yaml file.

There's no need to have separate script files or to run curl commands to pull in scripts from another repo -- you can do it all natively in GitHub actions.

See the GitHub actions docs:

• Creating a reusable workflow
• Calling a reusable workflow

The narrative repo has examples of workflow reuse, as well as eliminating the extra scripts in favour of using just the workflow yaml files.

Missing documentation

Need some more docs about

• Require status checks to pass before merging
• Require develop/main branch to be up to date before merging checkbox is dependent on this and undocumented
• Common mistakes and how to deal with the builds that didn't trigger (PR to main from feature branch, PR from feature branch to feature branch)
• How to trigger a build if a build didn't work (e.g. pushing a commit, or adding "ready_for_review" and toggling the PR draft to non draft)