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

Formalize process for PRs that require changes on test repos #2278

Closed
thomas-bc opened this issue Sep 19, 2023 · 5 comments
Closed

Formalize process for PRs that require changes on test repos #2278

thomas-bc opened this issue Sep 19, 2023 · 5 comments
Assignees

Comments

@thomas-bc
Copy link
Collaborator

F´ Version
Affected Component

Feature Description

CI now runs checks on external repositories such as https://github.com/fprime-community/fprime-workshop-led-blinker
When a user makes a PR that proposes a change that requires a change of how to use F´, this will result in breakage of the CI.

For now, we have a devel branch where users can make a PR and make the appropriate change (e.g. see fprime-community/fprime-workshop-led-blinker#38)
This becomes weird because we want master to host the latest docs, and devel to host the compatible version with devel of core F´... which leads to master and devel diverging.

Let's formalize (maybe rework?) and capture that process.

@thomas-bc
Copy link
Collaborator Author

An idea: devel has connotations that do not match our usage of the branch, unless we want the latest docs to be on devel as well. In that case, the argument could be made that we do not need the master branch on the tutorial repositories either. And we can make formal releases of each tutorials as well. But that will make the number of releases to be released on each release (lol) grow substantially.... not ideal.

If we want to keep a split of between main and a "devel" state, we could rename devel on the tutorials to be more meaningful, e.g. pr-checks or something. That branch would only be for validating PR changes on core F´. And we can merge that branch with a merge commit on each F´ release.

@thomas-bc thomas-bc self-assigned this Sep 19, 2023
@thomas-bc thomas-bc changed the title Formalize process for PRs that induce changes on test repos Formalize process for PRs that require changes on test repos Sep 19, 2023
@thomas-bc
Copy link
Collaborator Author

This also begs the question... how do we manage cases where 2 PRs are reviewed at the same time, and both require changes. We can't merge both into the tutorial's devel cause they will break each other...

@thomas-bc
Copy link
Collaborator Author

It also brings up a semi-concern. The current approach is to merge things into the tutorial's devel without really having fully reviewed/approved the changes that are going in there. That sounds a little odd to me.

@thomas-bc
Copy link
Collaborator Author

The above 2 comments lead me to believe that we may want to find a mechanism to have the CI run on ad-hoc branches, or at least re-label devel to something else.

@thomas-bc
Copy link
Collaborator Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant