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

docs(config options): rewrite forkProcessing #21621

Merged
merged 5 commits into from Apr 21, 2023

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Rewrite docs for forkProcessing
  • Monospace word in description for the config option

Context

Drive-by PR, not closing any issue.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@HonkingGoose HonkingGoose marked this pull request as ready for review April 20, 2023 08:32
@HonkingGoose
Copy link
Collaborator Author

The linter passes, but the build test shouts at me:

FAIL test/website-docs.spec.ts (5.683 s, 1271 MB heap size)
  ● website-docs › has headers for every required sub-option

    expect(received).toEqual(expected) // deep equality

    - Expected  - 0
    + Received  + 4

    @@ -1,6 +1,10 @@
      Array [
    +   "Allowed filenames",
    +   "Process a fork in `autodiscover` mode`",
    +   "Process a fork in other modes",
    +   "When using the hosted GitHub Mend Renovate app",
        "abortIgnoreStatusCodes",
        "abortOnError",
        "allowedVersions",
        "artifactAuth",
        "authType",

      74 |
      75 |   it('has headers for every required sub-option', () => {
    > 76 |     expect(headers3).toEqual(expectedOptions3);
         |                      ^
      77 |   });
      78 |
      79 |   // Checking relatedOptions field in options

      at Object.<anonymous> (test/website-docs.spec.ts:76:22)


Test Suites: 1 failed, 598 passed, 599 total

What do you want me to do?

  1. Remove headings and use bold text, or
  2. Let somebody else adjust the test.

@rarkins
Copy link
Collaborator

rarkins commented Apr 20, 2023

(1) use bold

docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
Co-authored-by: Rhys Arkins <rhys@arkins.net>
@rarkins rarkins enabled auto-merge April 20, 2023 10:33
@rarkins rarkins added this pull request to the merge queue Apr 21, 2023
Merged via the queue into renovatebot:main with commit 6990f7f Apr 21, 2023
11 checks passed
@HonkingGoose HonkingGoose deleted the docs/forkProcessing branch April 21, 2023 10:12
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 35.56.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants