Skip to content

BFD-4193: Restructure bfd-model-idr, set up formatting/linting, and add CI - #2781

Merged
aschey-forpeople merged 15 commits into
masterfrom
BFD-4193
Aug 22, 2025
Merged

BFD-4193: Restructure bfd-model-idr, set up formatting/linting, and add CI#2781
aschey-forpeople merged 15 commits into
masterfrom
BFD-4193

Conversation

@aschey-forpeople

Copy link
Copy Markdown
Contributor

JIRA Ticket:
BFD-4193

What Does This PR Do?

  • Updates repo structure
    • Moves the location of bfd-model-idr from apps/bfd-model/bfd-model-idr to apps/bfd-model-idr
    • Flattens directory structure within bfd-model-idr to minimize nesting
    • These changes should make it easier to locate the correct paths and minimize the number of cd operations
  • Formats all python code and fixes existing lint warnings
  • Adds CI for the pipeline and model
    • The complete process of generating and loading synthetic data will be checked for both the pipeline and model
    • This will catch regressions caused by changes to the data model or pipeline
  • Adds a new script compile-all-resources.sh to reduce the need to copy commands from the README
  • Updates README to be a bit easier to follow

What Should Reviewers Watch For?

If you're reviewing this PR, please check for these things in particular:

What Security Implications Does This PR Have?

Please indicate if this PR does any of the following:

  • Adds any new software dependencies

  • Modifies any security controls

  • Adds new transmission or storage of data

  • Any other changes that could possibly affect security?

  • I have considered the above security implications as it relates to this PR. (If one or more of the above apply, it cannot be merged without the ISSO or team security engineer's (@sb-benohe) approval.)

  • I have created tests to sufficiently ensure the reliability of my code, if applicable. If this is a modification to an existing piece of code, I have audited the associated tests to ensure everything works as expected.

Validation

Have you fully verified and tested these changes? Is the acceptance criteria met? Please provide reproducible testing instructions, code snippets, or screenshots as applicable.

Tested in CI, re-ran updated scripts

Comment thread .github/workflows/ci-pipeline-synthetic.yml
Comment thread apps/bfd-model-idr/gen_dd.py
Comment thread apps/bfd-model-idr/pyproject.toml
Comment thread .github/workflows/ci-pipeline-synthetic.yml
Comment thread apps/bfd-model-idr/.gitignore

@brick-green brick-green left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested and looks good to me

@aschey-forpeople
aschey-forpeople added this pull request to the merge queue Aug 22, 2025
Merged via the queue into master with commit 0bed8a2 Aug 22, 2025
11 checks passed
@aschey-forpeople
aschey-forpeople deleted the BFD-4193 branch August 22, 2025 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants