Skip to content

Race Condition in Model Docs and Website Updates in Same CI/CD Workflow #1447

@aj-stein-nist

Description

@aj-stein-nist

User Story

As a NIST OSCAL developer, in order to efficiently build updated reference model docs and website updates at the same time, I would like the CI/CD system to detect model update commits in the same workflow and git pull only under those conditions as to not fail the build.

Goals

  • Determine risk of automatically git pulling on branches where the model workflow-generate-website-reference.yml workflow step successfully executes and adds commits that are not detected by workflow-generate-website.yml steps that have not pulled in current changes.
    • Document risk decision.
  • Implement a check in CD workflow-generate-website.yml to git pull if workflow-generate-website-reference.yml did commit to the target main branch.

Dependencies

No response

Acceptance Criteria

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

Metadata

Metadata

Assignees

Labels

Scope: CI/CDEnhancements to the project's Continuous Integration and Continuous Delivery pipeline.enhancement

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions