The following are links to a preview of these wiki changes https://github.com/mdkinney/edk2/wiki/EDK-II-Continuous-Integration https://github.com/mdkinney/edk2/wiki/EDK-II-Continuous-Integration-Administration
Mike > -----Original Message----- > From: devel@edk2.groups.io <devel@edk2.groups.io> On > Behalf Of Michael D Kinney > Sent: Monday, December 2, 2019 9:57 AM > To: devel@edk2.groups.io > Cc: Sean Brogan <sean.bro...@microsoft.com>; Bret > Barkelew <bret.barke...@microsoft.com>; Gao, Liming > <liming....@intel.com>; Andrew Fish <af...@apple.com>; > Laszlo Ersek <ler...@redhat.com>; Leif Lindholm > <leif.lindh...@linaro.org> > Subject: [edk2-devel] [Patch wiki v2] EDK II CI: Update > Phase 1 details and admin settings > > https://bugzilla.tianocore.org/show_bug.cgi?id=2315 > > Update wiki pages providing details of the Phase 1 EDK > II Continuous Integration features and links to all > supporting documentation. Also provide notes for > admins to configure GitHub, Azure Pipelines, and > Mergify. > > Cc: Sean Brogan <sean.bro...@microsoft.com> > Cc: Bret Barkelew <bret.barke...@microsoft.com> > Cc: Liming Gao <liming....@intel.com> > Cc: Andrew Fish <af...@apple.com> > Cc: Laszlo Ersek <ler...@redhat.com> > Cc: Leif Lindholm <leif.lindh...@linaro.org> > Signed-off-by: Michael D Kinney > <michael.d.kin...@intel.com> > --- > ...I-Continuous-Integration-Administration.md | 100 > ++++++++++++++++++ > EDK-II-Continuous-Integration.md | 75 > ++++++++++--- > 2 files changed, 162 insertions(+), 13 deletions(-) > create mode 100644 EDK-II-Continuous-Integration- > Administration.md > > diff --git a/EDK-II-Continuous-Integration- > Administration.md b/EDK-II-Continuous-Integration- > Administration.md > new file mode 100644 > index 0000000..669d28a > --- /dev/null > +++ b/EDK-II-Continuous-Integration-Administration.md > @@ -0,0 +1,100 @@ > +# EDK II Continuous Integration Administration > + > +## Configuring edk2 repository > + > +1) Azure Pipelines Configuration Steps Part I > + 1) Goto https://dev.azure.com/tianocore > + 2) Create new project in TianoCore org called > `edk2-ci` > + 3) Disable Boards > + 4) Disable Repositories > + > +2) GitHub Configuration Steps Part I > + 1) Goto https://github.com/tianocore > + 2) Select Settings > + 3) Select Installed GitHub Apps > + 4) Select Azure Pipelines -> Configure > + * Enable `tianocore/edk2` repository > + * Redirects to Azure Pipelines login. Select > TianoCore org and > + `edk2-ci` project to complete link and > authentication between Azure > + Pipelines TianoCore organization and GitHub > TianoCore organization. > + > +3) Azure Pipelines Configuration Steps Part II > + 1) Goto https://dev.azure.com/tianocore/edk2- > ci/_build > + 2) Create New Pipeline called `Ubuntu GCC5 CI` for > post commit checks > + * YAML: Select file > https://github.com/tianocore/edk2/blob/master/.azurepip > elines/Ubuntu-GCC5.yml > + * Name: Set to `Ubuntu GCC5 CI` > + * Triggers: > + * CI - No changes > + * PR - Override + Disable > + * Variables: No changes > + * Save pipeline changes > + * Run pipeline and verify all checks pass > + 3) Create New Pipeline called `Windows VS2019 CI` > for post commit checks > + * YAML: Select file > https://github.com/tianocore/edk2/blob/master/.azurepip > elines/Windows-VS2019.yml > + * Name: `Windows VS2019 CI` > + * Triggers > + * CI - No changes > + * PR - Override + Disable > + * Variables: No changes > + * Save pipeline changes > + * Run pipeline and verify all checks pass > + 4) Create New Pipeline called `Ubuntu GCC5 PR` for > pre commit checks > + * YAML: Select file > https://github.com/tianocore/edk2/blob/master/.azurepip > elines/Ubuntu-GCC5.yml > + * Name: `Ubuntu GCC5 PR` > + * Triggers > + * CI - Override + Disable > + * PR - No changes > + * Variables: No changes > + * Save pipeline changes > + * Run pipeline. Pipeline will fail because it > requires a GitHub PR. Must > + run for pipeline name to show up in GitHub > Branch Protection Rules. > + 5) Create New Pipeline called `Windows VS2019 PR` > for pre commit checks > + * YAML: Select file > https://github.com/tianocore/edk2/blob/master/.azurepip > elines/Windows-VS2019.yml > + * Name: `Windows VS2019 PR` > + * Triggers > + * CI - Override + Disable > + * PR - No changes > + * Variables: No changes > + * Save pipeline changes > + * Run pipeline. Pipeline will fail because it > requires a GitHub PR. Must > + run for pipeline name to show up in GitHub > Branch Protection Rules. > + 6) Add PatchCheck pipeline for pre commit checks > + * YAML: Select file > https://github.com/tianocore/edk2/blob/master/.azurepip > elines/Ubuntu-PatchCheck.yml > + * Name: `tianocore.PatchCheck` > + * Triggers > + * CI - Override + Disable > + * PR - No changes > + * Variables: No changes > + * Save pipeline changes > + * Run pipeline. Pipeline will fail because it > requires a GitHub PR. Must > + run for pipeline name to show up in GitHub > Branch Protection Rules. > + > +4) GitHub Configuration Steps Part II > + 1) Goto https://github.com/tianocore/edk2 > + 2) Select Settings > + 3) Select Branches > + 4) Select Branch Protection Rules > + 5) Select `master` -> Edit > + * Enable `Require status checks to pass before > merging` > + * Enable `Require branches to be up to date > before merging` > + * Enable `Windows VS2019 PR` check > + * Enable `Ubuntu GCC5 PR` check > + * Enable `tianocore.PatchCheck` check > + 6) Goto https://github.com/tianocore > + 7) Select Settings > + 8) Select Installed GitHub Apps > + 9) Select Mergify -> Configure > + * Enable tianocore/edk2 repo > + > +5) Update Status Badge Links > + 1) Goto https://dev.azure.com/tianocore/edk2- > ci/_build > + 2) Select `Windows VS2019 CI` > + * Use '...' menu in upper right and select > Status badge > + * Copy Sample markdown > + * Update links in Build Status section of > https://github.com/tianocore/edk2/blob/master/Readme.md > + 3) Select `Ubuntu GCC5 CI` > + * Use '...' menu in upper right and select > Status badge > + * Copy Sample markdown > + * Update links in Build Status section of > https://github.com/tianocore/edk2/blob/master/Readme.md > + 4) Submit changes to Readme.md for EDK II code > review and submit GitHub PR to > + test personal build and Mergify commit once > review passes. > diff --git a/EDK-II-Continuous-Integration.md b/EDK-II- > Continuous-Integration.md > index bfe8f30..3b0e573 100644 > --- a/EDK-II-Continuous-Integration.md > +++ b/EDK-II-Continuous-Integration.md > @@ -1,23 +1,72 @@ > -# EDK II Continuous Integration Proposal > +# EDK II Continuous Integration > > -# Phase 1 (edk2 repository only) > -* Remove write access to edk2 repo > -* EDK II Maintainers use GitHub Pull Request instead > of push > -* Only accept PR from EDK II Maintainers. Reject all > other PRs. > -* Run basic Pre-commit checks > -* If all Pre-commit checks pass, then auto commit > changes > -* If any Pre-commit check fails, then notify submitter > -* Limit pre-commit check execution time to 10 minutes > -* Provide on-demand builds to EDK II Maintainers > +Summary of pre-commit and post-commit Continuous > Integration services > +that improve the quality of commits made to EDK II > repositories. The > +sections below list the Continuous Integration > services that are active > +and plans for future enhancements and extensions to > these services. > > -## Proposed Pre-Commit Checks in Phase 1 > -* PatchCheck.py > +## Phase 1 (edk2 repository only) - Activated November > 11, 2019 > + > +1) Use a combination of GitHub, Azure Pipelines, > Mergify, and edk2-pytool features. > + * GitHub Pull Requests + Labels, Branch > Protections, Notifications > + * Mergify Pull Request Rules with auto commit if > all checks pass > + * 3 pre-commit jobs in Azure Pipelines (PatchCheck, > Windows/VS, Linux/GCC). > + Goal is to complete all pre-commits check in > under 10 minutes. > + * 2 post-commit jobs in Azure Pipelines > (Windows/VS, Linux/GCC). Post commit > + status provided at top of `edk2/master` > [Readme.md](https://github.com/tianocore/edk2/blob/mast > er/Readme.md). > + * [EDK II Pytool > Library](https://github.com/tianocore/edk2-pytool- > library) > + * [EDK II Pytool > Extensions](https://github.com/tianocore/edk2-pytool- > extensions) > + * [TianoCore Bugzilla > #2315](https://bugzilla.tianocore.org/show_bug.cgi?id=2 > 315) > + * Original RFC Proposals > + - https://edk2.groups.io/g/rfc/message/93 > + - https://edk2.groups.io/g/devel/message/46607 > +2) Enable the following pre-commit checks > + * > [PatchCheck](https://github.com/tianocore/edk2/blob/mas > ter/BaseTools/Scripts/PatchCheck.py) > + * > [CharEncodingCheck](https://github.com/tianocore/edk2/t > ree/master/.pytool/Plugin/CharEncodingCheck) > + * > [CompilerPlugin](https://github.com/tianocore/edk2/tree > /master/.pytool/Plugin/CompilerPlugin) > + * > [DependencyCheck](https://github.com/tianocore/edk2/tre > e/master/.pytool/Plugin/DependencyCheck) > + * > [DscCompleteCheck](https://github.com/tianocore/edk2/tr > ee/master/.pytool/Plugin/DscCompleteCheck) > + * > [GuidCheck](https://github.com/tianocore/edk2/tree/mast > er/.pytool/Plugin/GuidCheck) > + * > [LibraryClassCheck](https://github.com/tianocore/edk2/t > ree/master/.pytool/Plugin/LibraryClassCheck) > + * > +[SpellCheck](https://github.com/tianocore/edk2/tree/ma > ster/.pytool/Plug > +in/SpellCheck) > +3) TianoCore EDK II Maintainers Team permissions > reduced from 'Write" to "Triage" > +4) EDK II Maintainers must use GitHub pull request > with 'push' label to request > + a branch to be strict rebase merged into > `edk2/master`. If all checks pass, > + then the patches in the pull request are > automatically added to `edk2/master`. > + If any checks fails, then email notifications are > sent and details of the > + failure are available through Azure Pipelines test > results. > +5) Personal builds available to all EDK II developers > using a GitHub pull > + request without the 'push' label set. If all > checks pass, then a notification > + email is sent and the pull request is closed. If > any checks fails, then > + email notifications are sent and the details of the > failure are available > + through Azure Pipelines test results. > +6) GitHub References > + * [GitHub](https://github.com/) > + * [GitHub > Labels](https://help.github.com/en/github/managing- > your-work-on-github/about-labels) > + * [GitHub Protected > Branches](https://help.github.com/en/github/administeri > ng-a-repository/about-protected-branches) > + * [GitHub > Notifications](https://help.github.com/en/github/receiv > ing-notifications-about-activity-on-github/about- > notifications) > + * [Watch a GitHub > repository](https://help.github.com/en/github/receiving > -notifications-about-activity-on-github/watching-and- > unwatching-repositories) > + * [Create a GutHub > fork](https://help.github.com/en/github/getting- > started-with-github/fork-a-repo) > + * [Create a GitHub pull > +request](https://help.github.com/en/github/collaborati > ng-with-issues-an > +d-pull-requests/creating-a-pull-request) > +7) HUB Command line Utility to perform GitHub > operations > + * [HUB > Releases](https://github.com/github/hub/releases) > + * [HUB Usage](https://hub.github.com/hub.1.html) > +8) Azure Pipelines References > + * [Azure Piplelines GitHub > App](https://github.com/marketplace/azure-pipelines) > + * [Azure Pipelines TianoCore edk2-ci > Project](https://dev.azure.com/tianocore/edk2-ci) > + * [Azure Pipelines TianoCore edk2-ci > Pipelines](https://dev.azure.com/tianocore/edk2- > ci/_build) > + * [Azure Pipelines](https://azure.microsoft.com/en- > us/services/devops/pipelines) > + * [Azure Pipelines YAML > +Schema](https://docs.microsoft.com/en- > us/azure/devops/pipelines/yaml-sc > +hema) > +9) Mergify References > + * [Mergify GitHub > App](https://github.com/apps/mergify) > + * [Mergify Documentation](https://doc.mergify.io) > + > +[[EDK II Continuous Integration Administration]] > > ## Proposed Pre-Commit Checks in Phase 2 > * Verify Reviewed-by and Acked-by tags are present > with correct maintainers > * 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 > -- > 2.21.0.windows.1 > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#51558): https://edk2.groups.io/g/devel/message/51558 Mute This Topic: https://groups.io/mt/65104387/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
