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.

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

Remove/update incorrect docs building documentation #1128

Merged
merged 5 commits into from
Feb 20, 2024

Conversation

felixfontein
Copy link
Collaborator

MODULES= and PLUGINS= hasn't worked for quite some time for Makefile (basically since Ansible 2.10).

@felixfontein felixfontein added backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.14 Automatically create a backport for the stable-2.14 branch backport-2.16 Automatically create a backport for the stable-2.16 branch labels Feb 17, 2024
Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @felixfontein

@felixfontein felixfontein merged commit a4cb511 into ansible:devel Feb 20, 2024
8 checks passed
@felixfontein felixfontein deleted the docs-build branch February 20, 2024 12:46
Copy link

patchback bot commented Feb 20, 2024

Backport to stable-2.15: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply a4cb511 on top of patchback/backports/stable-2.15/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128

Backporting merged PR #1128 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.15/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128 upstream/stable-2.15
  4. Now, cherry-pick PR Remove/update incorrect docs building documentation #1128 contents into that branch:
    $ git cherry-pick -x a4cb511c64f141016f6f217740d37a98894aa576
    If it'll yell at you with something like fatal: Commit a4cb511c64f141016f6f217740d37a98894aa576 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x a4cb511c64f141016f6f217740d37a98894aa576
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Remove/update incorrect docs building documentation #1128 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.15/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link

patchback bot commented Feb 20, 2024

Backport to stable-2.14: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply a4cb511 on top of patchback/backports/stable-2.14/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128

Backporting merged PR #1128 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.14/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128 upstream/stable-2.14
  4. Now, cherry-pick PR Remove/update incorrect docs building documentation #1128 contents into that branch:
    $ git cherry-pick -x a4cb511c64f141016f6f217740d37a98894aa576
    If it'll yell at you with something like fatal: Commit a4cb511c64f141016f6f217740d37a98894aa576 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x a4cb511c64f141016f6f217740d37a98894aa576
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Remove/update incorrect docs building documentation #1128 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.14/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link

patchback bot commented Feb 20, 2024

Backport to stable-2.16: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply a4cb511 on top of patchback/backports/stable-2.16/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128

Backporting merged PR #1128 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.16/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128 upstream/stable-2.16
  4. Now, cherry-pick PR Remove/update incorrect docs building documentation #1128 contents into that branch:
    $ git cherry-pick -x a4cb511c64f141016f6f217740d37a98894aa576
    If it'll yell at you with something like fatal: Commit a4cb511c64f141016f6f217740d37a98894aa576 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x a4cb511c64f141016f6f217740d37a98894aa576
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Remove/update incorrect docs building documentation #1128 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.16/a4cb511c64f141016f6f217740d37a98894aa576/pr-1128
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein
Copy link
Collaborator Author

Wow, not even backporting to stable-2.16 worked...

felixfontein added a commit to felixfontein/ansible-documentation that referenced this pull request Feb 20, 2024
* MODULES= and PLUGINS= haven't worked since ansible-base 2.10.

* MODULES= no longer exists.

* Fix dash.

* Remove no longer correct parts.

* Mention --docker option.

(cherry picked from commit a4cb511)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.14 Automatically create a backport for the stable-2.14 branch backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants