Skip to content

Workflow Contributor Gatekeeper XItemOwner

Jump to bottom
Rahul Kunwar edited this page Sep 6, 2020 · 2 revisions

Important information about Git branch in this document

Although most of the contributions typically target the master branch, the actual branch accepting contributions depends on the Vivado release and needs to be checked on this page.

Work Flow between the Contributor, the XItem Owner and the Gate Keeper

There are two different processes depending on whether the revision number of the xitem has been updated or not. If the contributor is not the xitem owner, the app revision number should not be updated. Updating the xitem revision number is only done by the xitem owner once he/she has verified the pull requests(s) from other contributor(s).

The xitem owner is submitting/updating the data/code

  1. The xitem owner clones his GitHub repo in a local area (Windows or Linux)

  2. The xitem owner creates/update the revision number inside xitem.json and commit the changes to his/her GitHub repo.

  3. The xitem owner goes to GitHub.com and submits a pull request

  4. The Gate Keeper receives the pull request and check that the xitem revision number looks correct

  5. The Gate Keeper merges the code inside the XilinxCEDStore repo. For New xitem's, Gate Keeper adds an entry in xstore.json driven xitem-catalog file. Finally adds a comment and close the pull request

The contributor is updating the xitem data/code ( When Contributor is not the same as xitem owner )

  1. The Contributor clones his GitHub repo in a local area (Windows or Linux)

  2. The Contributor add or modify some code and commit the changes to his/her GitHub repo.

    Note: The xitem revision number should not have been updated. However, the xitem.json file must have been updated as needed

  3. The Contributor goes to GitHub.com and submit a pull request

  4. The Gate Keeper receives the pull request. He adds a comment to it and assign the pull request to the Xitem Owner

  5. The Xitem Owner gets notified. He has the responsibility to check the code inside the pull request

  6. If the code is passing the tests, the Xitem Owner can increment the xitem revision number. That's only after incrementing the xitem revision number that the changes become available to all the users through "Refresh Catalog".

    If the code is failing the tests, the Xitem Owner adds some explanations to the pull request from GitHub.com and rejects the pull request

  7. Once the Xitem Owner has blessed the pull request, the Gate Keeper merges the code inside the XilinxCEDStore repo, adds a comment and close the pull request

Clone this wiki locally