diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d7e04b..5ba685a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,8 @@ Every user-facing change should have an entry in this changelog. Please respect ## Unreleased +- [Improvement] Use `git am` instead of `cherry-pick` to simplify patching process. + ## v14.0.1 (2022-06-13) - [Bugfix] Fix missing tables on migration from maple ([#689](https://github.com/overhangio/tutor/issues/689)). (by @ibrmora) diff --git a/docs/dev.rst b/docs/dev.rst index d552589..1d36fdb 100644 --- a/docs/dev.rst +++ b/docs/dev.rst @@ -9,7 +9,7 @@ In addition to running Open edX in production, Tutor can be used for local devel First-time setup ---------------- -First, ensure you have already `installed Tutor `_ (for development against the named releases of Open edX) or `Tutor Nightly `_ (for development against Open edX's master branches). +First, ensure you have already :ref:`installed Tutor ` (for development against the named releases of Open edX) or :ref:`Tutor Nightly ` (for development against Open edX's master branches). Then, launch the developer platform setup process:: diff --git a/tutor/templates/build/openedx/Dockerfile b/tutor/templates/build/openedx/Dockerfile index ca7ffab..922244a 100644 --- a/tutor/templates/build/openedx/Dockerfile +++ b/tutor/templates/build/openedx/Dockerfile @@ -38,7 +38,7 @@ RUN mkdir -p /openedx/edx-platform && \ git clone $EDX_PLATFORM_REPOSITORY --branch $EDX_PLATFORM_VERSION --depth 1 /openedx/edx-platform WORKDIR /openedx/edx-platform -# Identify tutor user to cherry-pick commits +# Identify tutor user to apply patches using git RUN git config --global user.email "tutor@overhang.io" \ && git config --global user.name "Tutor" @@ -49,7 +49,7 @@ RUN git config --global user.email "tutor@overhang.io" \ # Patch edx-platform {%- endif %} -{# Example: RUN git fetch --depth=2 https://github.com/openedx/edx-platform && git cherry-pick #} +{# Example: RUN curl -fsSL https://github.com/openedx/edx-platform/commit/ | git am #} {{ patch("openedx-dockerfile-post-git-checkout") }} ###### Download extra locales to /openedx/locale/contrib/locale