Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Validate Templates (#2387) #2990

Open
wants to merge 5 commits into
base: devel
Choose a base branch
from

Conversation

rlcheng
Copy link
Collaborator

@rlcheng rlcheng commented Oct 28, 2024

  • Add validate_templates.yml and support expect scripts.
Related Issue(s)
Has Unit Tests (y/n)
Documentation Included (y/n)

Change Description

A description of the changes contained in the PR.

Rationale

A rationale for this change. e.g. fixes bug, or most projects need XYZ feature.

Testing/Review Recommendations

Fill in testing procedures, specific items to focus on for review, or other info to help the team verify these changes are flight-quality.

Future Work

Note any additional work that will be done relating to this issue.

 - Add validate_templates.yml and support expect scripts.
.github/workflows/validate_templates.yml Show resolved Hide resolved
.github/workflows/validate_templates.yml Show resolved Hide resolved
.github/workflows/validate_templates.yml Show resolved Hide resolved
 * Update CI to be 3 distinct steps and build each step.
@rlcheng rlcheng force-pushed the validate_templates branch 13 times, most recently from 988b809 to 6cf0fe7 Compare October 29, 2024 15:32
Copy link
Collaborator

@thomas-bc thomas-bc left a comment

Choose a reason for hiding this comment

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

This is really neat! 🚀

One question: do we want to have this workflow run on the devel state of fprime-bootstrap and fprime-tools ?
This would allow us to validate that we are keeping bootstrap/tools in sync with the devel version of F Prime. It could match the process in the tutorials tests, see e.g.

get-branch:
name: "Get target branch"
uses: ./.github/workflows/reusable-get-pr-branch.yml
with:
target_repository: fprime-community/fprime-tutorial-hello-world

This has been a pretty successful process for the tutorials so far.

.github/workflows/validate_templates.yml Show resolved Hide resolved
@rlcheng rlcheng force-pushed the validate_templates branch 10 times, most recently from ab3efa6 to 94456ed Compare October 29, 2024 20:17
 * Update expect scripts to use regex where needed to match strings.
 * Update CI run condition to match other F Prime CI.
@LeStarch
Copy link
Collaborator

Released fprime-bootstrap should work on the latest release.

devel fprime-bootstrap and devel fprime-tools should work with devel fprime. No?

@thomas-bc
Copy link
Collaborator

thomas-bc commented Oct 29, 2024

Yes, they should. But we can't confirm that they actually do unless we check it in CI. I am suggesting we should do that, following the same pattern that we use on our tutorial repositories.

e.g.

pip install git+https://github.com/nasa/fprime-tools@{devel,pr-xxxx} // and bootstrap
fprime-bootstrap project
git clone https://github.com/nasa/fprime      // use fprime@devel in the new project
fprime-util build
fprime-util new --deployment
cd MyDeployment
fprime-util build

This validates that the latest devel of fprime, fprime-tools and fprime-bootstrap are all in sync.

Or am I missing your point?

@rlcheng rlcheng force-pushed the validate_templates branch 2 times, most recently from 7eda623 to 7450ca1 Compare October 30, 2024 19:39
 * Update to use devel fprime-tools and fprime-bootstrap instead
   of released version.
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.

Add CI workflow to validate cookiecutter templates
3 participants