{"id":23282779,"url":"https://github.com/itsallcode/openfasttrace-github-action","last_synced_at":"2025-08-21T13:33:45.376Z","repository":{"id":253942466,"uuid":"842834487","full_name":"itsallcode/openfasttrace-github-action","owner":"itsallcode","description":"GitHub Action for tracing requirements using OpenFastTrace","archived":false,"fork":false,"pushed_at":"2024-08-23T06:39:56.000Z","size":23,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-23T18:54:26.446Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itsallcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-15T07:33:13.000Z","updated_at":"2024-08-23T06:39:59.000Z","dependencies_parsed_at":"2024-08-20T14:08:08.976Z","dependency_job_id":null,"html_url":"https://github.com/itsallcode/openfasttrace-github-action","commit_stats":null,"previous_names":["itsallcode/openfasttrace-github-action"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-github-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-github-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-github-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-github-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsallcode","download_url":"https://codeload.github.com/itsallcode/openfasttrace-github-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230519184,"owners_count":18238836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-20T00:29:47.099Z","updated_at":"2025-08-21T13:33:45.371Z","avatar_url":"https://github.com/itsallcode.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenFastTrace Action\n\nA GitHub Action for tracing requirements using OpenFastTrace.\n\nRuns OpenFastTrace CLI's `trace` command using Temurin JRE 22 on the local workspace.\n\nThe action has the following inputs:\n\n| Name              | Required | Description                                                                                                                                                                                                                                                                                 |\n| :---------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `file-patterns`   | `false`  | A whitespace separated list of (Bash standard) glob patterns which specify the files and directories to include in the OFT trace run.\u003cbr\u003eIf not specified, the local workspace directory is used.                                                                                           |\n| `report-filename` | `true`   | The name of the file that OpenFastTrace should write the analysis results to.                                                                                                                                                                                                               |\n| `report-format`   | `false`  | The format of the report that OpenFastTrace should produce. Default value is `plain`.                                                                                                                                                                                                       |\n| `tags`            | `false`  | A comma separated list of tags to use for [filtering specification items](https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide.md#distributing-the-detailing-work).\u003cbr\u003eIf not set explicitly, all specification items from files matching the file patterns are considered. |\n| `fail-on-error`   | `false`  | By default, the action will never fail but indicate the result of running the trace command in the `oft-exit-code` output variable.\u003cbr\u003eSetting this parameter to `true` will let the Action return the exit code produced by running OpenFastTrace.                                         |\n\nThe action has the following outputs:\n\n| Name            | Description                                                                                                                                                    |\n| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `oft-exit-code` | `0`: OFT has run successfully and all specification items are covered\u003cbr\u003e`\u003e1`: OFT has either failed to run or at least one specification item is not covered. |\n\n## Example workflow\n\nThe following workflow illustrates how the action can be used to trace requirements in the local workspace. The report will always be uploaded as an attachment to the workflow run, even if the trace run fails.\n\n```yaml\non:\n  pull_request:\n\njobs:\n  tracing:\n    name: Run OpenFastTrace\n    runs-on: ubuntu-latest\n    env\n      TRACING_REPORT_FILE_NAME: oft-tracing-report.html\n    outputs:\n      tracing-report-url: ${{ steps.upload-tracing-report.artifact-url }}\n    steps:\n    - uses: actions/checkout@v4\n\n    - name: Run OpenFastTrace\n      id: run-oft\n      uses: itsallcode/openfasttrace-github-action@v0\n      with:\n        file-patterns: *.md *.adoc src/\n        report-format: \"html\"\n        report-filename: ${{ env.TRACING_REPORT_FILE_NAME }}\n        tags: Priority1,OtherComponent\n\n    - name: Upload tracing report (html)\n      uses: actions/upload-artifact@v4\n      id: upload-tracing-report\n      if: ${{ steps.run-oft.outputs.oft-exit-code != '' }}\n      with:\n        name: tracing-report-html\n        path: ${{ env.TRACING_REPORT_FILE_NAME }}\n\n    - name: \"Determine exit code\"\n      run: |\n        exit ${{ steps.run-oft.outputs.oft-exit-code }}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsallcode%2Fopenfasttrace-github-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsallcode%2Fopenfasttrace-github-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsallcode%2Fopenfasttrace-github-action/lists"}