existing-repository.md

Existing Repository

Contents

• Preliminary Steps
• Add Actions To Repository
  • Existing Repo Demo
• Next Steps

---

Preliminary Steps

1. Ensure that your repo contains the following up-to-date branches:
   • main or master
   • develop
   • inbox
2. Review your current repo's .github/workflows/ directory if one currently exists.
3. Ensure there are no files named pr_build.yml or release-main.yml in the .github/workflows/ directory.
   • If these files aleady exist, they can't be added using the Add Actions To Repository steps below.
   • If these files match the current stock pr_build.yaml & release-main.yml, these workflows are already enabled, and you can skip to the Enable Branch Rules section.
4. Review any other .yaml/.yml files in .github/workflows/ to ensure they aren't redundant or are causing unnecessary failed builds.

Add Actions To Repository

To enable the KBase build scripts on an existing github.com/kbase repo, simply:

1. Navigate to the Actions tab on any repository in the kbase organization.
2. If there are any existing Actions (workflows) enabled, click on the New workflow button above the list of active workflows.
   • If the repo does not have any active Actions (workflows), then a Get started with GitHub Actions page will appear instead.
3. Navigate to the By KBase Software section.
4. Click Configure under the Pull Request Build, Tag, & Push Action.
5. Click Start commit to add the file pr_build.yml to the main or master branch of the repo.
6. Repeat steps 1-5 to add the Build Production Release Image (release-main.yml) Action to the main or master branch of the repo.
7. Optionally, repeat steps 1-5 to add the Manual Build & Push (manual-build.yml) Action to the main or master branch of the repo.
8. Use pull requests to propagate the workflow files to all active branches including:
   • main/master
   • develop
   • inbox
   • Any active feature branches

⚠️ These workflows must be merged to all active branches for full functionality!

Existing Repo Demo

Expand For Demo

---

Next Steps

Before using these actions, please:

1. Review the Development Workflow and Release Workflow sections.
2. Enable the required branch rules and status checks.
3. File a request with the DevOps team (via Jira or Slack) to make any resulting images public.

---

|| Previous: New Repository || Home || Next: Enable Branch Rules ||