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.

Sign up for GitHub

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

Jump to bottom

document new GitHub integration features ... #579

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

document new GitHub integration features ... #579

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions docs/Integration_with_GitHub.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,7 @@ significantly easier and less error-prone, especially for people who are not ver
yet:

* ``--new-pr`` to create new pull requests
* Since EasyBuild v4.1.0, it is possible to first push a new branch to GitHub without immediately creating the corresponding PR to ``develop``, using ``--new-branch-github``, in order to check if the CI tests pass, and only then actually open the PR, using ``--new-pr-from-branch``.
* ``--update-pr`` to update existing pull requests

.. _github_preview_pr:
Expand All @@ -574,7 +575,7 @@ as described in :ref:`contributing_review_process_review_pr`.

.. _github_new_pr:

Submitting pull requests (``--new-pr``)
Submitting pull requests (``--new-pr``, ``--new-branch-github``, ``--new-pr-from-branch``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note:: Submitting pull requests using ``--new-pr`` only works for the ``easybuild-easyconfigs`` repository, for now.
Expand All @@ -597,6 +598,8 @@ This takes care of all the steps required to make a contribution, i.e.:
* pushing the feature branch to your fork of the relevant EasyBuild repository on GitHub
* creating the pull request, targeting the ``develop`` branch of the central EasyBuild repository (e.g. ``easybuilders/easybuild-easyconfigs``)

.. note:: Since EasyBuild v4.1.0, using ``--new-branch-github`` instead of ``--new-pr`` will perform all these steps except the last one, which can be performed separately using ``--new-pr-from-branch``.

It should be clear that automating this whole procedure with a single simple ``eb`` command greatly lowers the bar
for contributing, especially since it even alleviates the need for interacting directly with ``git`` entirely!

Expand Down Expand Up @@ -636,7 +639,7 @@ Yes, it's that easy!

.. _github_update_pr:

Updating existing pull requests (``--update-pr``)
Updating existing pull requests (``--update-pr``, ``--update-branch-github``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note:: Updating pull requests using ``--update-pr`` only works for the ``easybuild-easyconfigs`` repository, for now.
Expand All @@ -649,6 +652,9 @@ The usage is equally simple, for example to update pull request ``#1234`` just l

$ eb --update-pr 1234 example.eb

.. note:: If only a branch was created, with ``--new-branch-github``, it can be updated with ``--update-branch-github``,
using the branch name instead of PR number

Again, this take care of the whole procedure required to update an existing pull request:

* set up a working copy of the relevant EasyBuild repository (e.g., ``easybuild-easyconfigs``)
Expand Down Expand Up @@ -684,6 +690,32 @@ For example, to update pull request #3153 with a changed easyconfig file::

Updated easybuilders/easybuild-easyconfigs PR #3159 by pushing to branch boegel/20160530131447_new_pr_EasyBuild281

.. _github_sync_with_develop:

Syncing with ``develop`` (``--sync-branch-with-develop``, ``--sync-pr-with-develop``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*(supported since EasyBuild v4.1.0)*

With ``--sync-branch-with-develop`` or ``--sync-pr-with-develop``, you can sync a specific GitHub branch, determined by the branch name
if a PR hasn't been created yet or by the PR number if it has, with the latest version of the ``develop`` branch from the central repository.

Example
+++++++

For example, to sync pull request #7277 with the current version of ``develop``::

eb --sync-pr-with-develop 7277
== temporary log file in case of crash /tmp/eb-Uul_00/easybuild-kwe1IC.log
== Determined branch name corresponding to easybuilders/easybuild-easyconfigs PR #7277: 20181210212203_new_pr_ack224
== cloning git repo from /user/example/easybuild-easyconfigs...
== fetching branch '20181210212203_new_pr_ack224' from https://github.com/boegel/easybuild-easyconfigs.git...
== pulling latest version of 'easybuilders' branch from easybuild-easyconfigs/develop...
== merging 'develop' branch into PR branch '20181210212203_new_pr_ack224'...
== pushing branch '20181210212203_new_pr_ack224' to remote 'github_boegel_IhzHm' ([email protected]:boegel/easybuild-easyconfigs.git)
== Temporary log file(s) /tmp/eb-Uul_00/easybuild-kwe1IC.log* have been removed.
== Temporary directory /tmp/eb-Uul_00 has been removed.

.. _github_new_update_pr_patches:

Including patch files in easyconfigs pull requests
Expand Down