[edk2-devel] [RFC] EDK II Continuous Integration Phase 1

[Michael D Kinney]

Hello,

This is a proposal for a first step towards continuous
integration for all TianoCore repositories to help 
improve to quality of commits and automate testing and
release processes for all EDK II packages and platforms.

This is based on work from a number of EDK II community
members that have provide valuable input and evaluations.

* Rebecca Cran <rebecca at bsdio.com> Jenkins evaluation
* Laszlo Ersek <lersek at redhat.com> GitLab evaluation
* Philippe Mathieu-Daudé <philmd at redhat.com> GitLab evaluation
* Sean Brogan <sean.brogan at microsoft.com> Azure Pipelines and HBFA
* Bret Barkelew <Bret.Barkelew at microsoft.com> Azure Pipelines and HBFA
* Jiewen Yao <jiewen.yao at intel.com> HBFA

The following link is a link to an EDK II WIKI page that
contains a summary of the work to date.  Please provide
feedback in the EDK II mailing lists.  The WIKI pages will
be updated with input from the entire EDK II community.

    https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Continuous-Integration

Proposal
========
Phase 1 of adding continuous integration is limited to the
edk2 repository.  Additional repositories will be added later.

The following changes are proposed:
* Remove EDK II Maintainers write access to edk2 repository.
  Only EDK II Administrators will continue to have write 
  access, and that should only be used to handle extraordinary
  events.
* EDK II Maintainers use a GitHub Pull Request instead of push
  to commit a patch series to the edk2 repository.  There are
  no other changes to the development and review process.  The
  patch series is prepared in an EDK II maintainer branch with
  all commit message requirements met on each patch in the series.
* The edk2 repository only accepts Pull Requests from members
  of the EDK II Maintainers team.  Pull Requests from anyone else
  are rejected.
* Run pre-commit checks using Azure Pipelines
* If all pre-commit checks pass, then the patch series is auto
  committed.  The result of this commit must match the contents
  and commit history that would have occurred using the previous
  push operation.
* If any pre-commit checks fail, then notify the submitter.
  A typical reason for a failure would be a merge conflict with
  another pull request that was just processed.
* Limit pre-commit checks execution time to 10 minutes.
* Provide on-demand builds to EDK II Maintainers that to allow
  EDK II Maintainers to submit a branch through for the same
  set of pre-commit checks without submitting a pull request.

## Pre-Commit Checks in Phase 1
* Run and pass PatchCheck.py with no errors

=====================================================

The following are some additional pre-commit check ideas
that could be quickly added once the initial version using
PatchCheck.py is fully functional.  Please provide feedback
on the ones you like and additional ones you think may 
improve the quality of the commits to the edk2 repository.

## Proposed Pre-Commit Checks in Phase 2
* Verify Reviewed-by and Acked-by tags are present with
  correct maintainer email addresses
* Verify no non-ASCII characters in modified files
* Verify no binary files in set of modified files
* Verify package dependency rules in modified files

## Proposed Pre-Commit Checks in Phase 3
* Run ECC on modified files
* Verify modified modules/libs build
* Run available host based tests (HBFA) against modified
  modules/libs

Best regards,

Mike






-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#46582): https://edk2.groups.io/g/devel/message/46582
Mute This Topic: https://groups.io/mt/33072637/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-