PX4-user_guide icon indicating copy to clipboard operation
PX4-user_guide copied to clipboard

Published 20 hours ago • verified publisher icon PX4

Detailed PX4 CI documentation

Open junwoo091400 opened this issue 2 years ago • 11 comments

About

More rigorous documentation actually detailing what goes behind the curtain on PX4 CI system is added.

Motivation

This was one of the most magical things I learned when I was working on Frames metadata support in QGC: https://github.com/mavlink/qgroundcontrol/pull/10472

In hopes of having this mysterious CI system getting better documented, I created this PR!

junwoo091400 avatar Feb 17 '23 16:02 junwoo091400

@junwoo091400 I've restructured this a bit. All the stuff specific to QGC and PX4 docs should go under those sections. So you can talk about what PX4 does with actions and Jenkins in those folders, and there might end up being some duplication in the QGC and Docs sections.

It is not clear to me how Jenkins is kicked off? Is this magic or is it done by deploy_all action? In other words what is the relationship/handover, if any between the systems?

I can't review this for technical accuracy. Who can?

hamishwillee avatar Feb 22 '23 01:02 hamishwillee

PS The Jenkins stuff doesn't happen by default - it has been broken for months and months. I kick it off manually every week or so. No one seems to care.

hamishwillee avatar Feb 22 '23 01:02 hamishwillee

It is not clear to me how Jenkins is kicked off? Is this magic or is it done by deploy_all action?

This I have no clue for now. I can ask @dagar

Jenkins stuff doesn't happen by default - it has been broken for months and months

I'm sorry that this has been happening. I was aware & wanted to at least figure out for myself what was going wrong, which was partly the motivation for this PR.

I will ask about Jenkins situation in the maintainers chat 🙏. I will help getting this resolved!

junwoo091400 avatar Feb 22 '23 06:02 junwoo091400

I will ask about Jenkins situation in the maintainers chat 🙏. I will help getting this resolved!

Thanks. @dagar is probably the only one who can fix it.

hamishwillee avatar Mar 01 '23 00:03 hamishwillee

@junwoo091400 Is this waiting on review? In that case, perhaps we could ask @bkueng for a sanity check.

hamishwillee avatar Mar 15 '23 04:03 hamishwillee

Yes that makes sense!

junwoo091400 avatar Mar 15 '23 06:03 junwoo091400

Note, I am not tracking this. @junwoo091400 when you have resolved issues with @bkueng et al, come back to me and I will subedit.

hamishwillee avatar Apr 20 '23 03:04 hamishwillee

Updated the PR. Two remaining notes:

  1. @dagar Seems like test rack CI is not running recently (jenkins/continuous-integration one that used to fail a lot). Was that disabled?
  2. As I reported in https://github.com/PX4/PX4-Autopilot/issues/22383, currently metadata isn't being uploaded into appropriate directories correctly so I didn't go in detail regarding that mechanism in the docs, since it's not fixed yet (still docs is true to code's status)

junwoo091400 avatar Nov 16 '23 09:11 junwoo091400

@junwoo091400 Just a reminder to me when you're ready for final review. That should be after Beat and Daniel say they are happy enough for this to be published.

hamishwillee avatar Nov 23 '23 05:11 hamishwillee

@junwoo091400 Just a reminder to me when you're ready for final review. That should be after Beat and Daniel say they are happy enough for this to be published.

I would hold it a bit for now, as we just had discussion on the overall CI infrastructure and there are some improvements we can have, and change the Docs appropriately.

junwoo091400 avatar Nov 23 '23 05:11 junwoo091400

No flaws found

github-actions[bot] avatar Nov 23 '23 09:11 github-actions[bot]