GitHub and Requirements Training

Connecting a GitHub repository to PORTWARE and using it: connection, repository, project automation, code on a task, product release and SBOM, requirements traceability, Cowork.

Who this course is forFor teams that build products with software or firmware: project managers, developers, quality and after-sales support. By the end you connect a GitHub repository to PORTWARE and follow a task through its code, a product through its release and a requirement through its evidence.

The company, people and tasks in the screenshots come from the PORTWARE demo database; the repository is a real, public open-source project (OpenEtherCATsociety/SOEM).

The learning path

The learning path of the GitHub course1 · Set-up0 Why?1 Connection2 Repository2 · Daily work3 Project4 Code on a task5 Product and release3 · Trace6 Requirements7 Follow-up, Cowork4 · Mastery8 TroubleshootingGlossary and test
Four stages, nine lessons. An administrator does the set-up once; the daily-work and trace lessons are for everyone on the team.

Lessons

Lesson 0Why GitHub inside PORTWARE?Why code, work and requirements belong in one place.8 minutes
Lesson 1Setting up the connectionAccess token, GitHub App or a connection without one.15 minutes
Lesson 2Adding and synchronising a repositoryLink it to a product and a project, sync, install the webhook.12 minutes
Lesson 3Project and automationLet tasks move with their pull requests.8 minutes
Lesson 4Working with code on a taskTask key, branch name, commit rules, the development panel.15 minutes
Lesson 5Product, release and SBOMSoftware products, release notes, the software bill of materials.10 minutes
Lesson 6Requirements and traceabilityWrite a requirement, link it, see the gap in the matrix.18 minutes
Lesson 7Follow-up, figures and CoworkThe pull request list, delivery figures, asking the assistant.10 minutes
Lesson 8Troubleshooting, checklist, testCommon situations and the final test.12 minutes
Lesson 9PORTWARE Git StudioThe product's software studio, versions, baselines and review.18 minutes
Lesson 10Workbench and customer versionsBrowsing code, comparing two versions, pinning a version for a customer.20 minutes
Lesson 11Verification, build and deployProving a requirement with tests, building and deploying with GitHub Actions, smart tools.20 minutes

The example in this course

PORTWARE's EtherCAT servo drive talks over the open-source SOEM stack. The course follows the same repository, product and project throughout.

RecordRole in the course
OpenEtherCATsociety/SOEMThe open-source EtherCAT master; real commits, PRs and releases
PW-SD-750Servo Drive 750 W · EtherCAT — the product that carries the software
Servo Drive SoftwareFour tasks, five requirements, automation on

Modules this course uses

ModuleWhat it gives
PORTWARE GitHubConnection, repository, branch, commit, pull request, release, build, SBOM, webhook
PORTWARE RequirementsRequirement, acceptance criteria, verification, traceability matrix
PORTWARE GitHub Releases for Project TrackerGitHub release ↔ PORTWARE project release
PORTWARE GitHub for CoworkGitHub tools for the Cowork assistant

For a summary and the limits see the module page: GitHub and requirements traceability.