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(datasource): Add additional examples for custom datasource #23558

Merged
merged 8 commits into from
Aug 1, 2023
Merged

docs(datasource): Add additional examples for custom datasource #23558

merged 8 commits into from
Aug 1, 2023

Conversation

SirUli
Copy link
Contributor

@SirUli SirUli commented Jul 25, 2023

Changes

Added the examples for hashicorp and offline dependencies for the custom datasource

Context

Following the request of a maintainer here.

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

Added the examples for hashicorp and offline dependencies
@secustor secustor self-requested a review July 30, 2023 19:17
secustor
secustor previously approved these changes Jul 30, 2023
@secustor
Copy link
Collaborator

Needs linting errors to be fixed, else LGTM.

lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
SirUli and others added 2 commits July 31, 2023 17:37
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@secustor secustor left a comment

Choose a reason for hiding this comment

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

Please use JSON, that way we get code highlighting in the documentation.

@SirUli
Copy link
Contributor Author

SirUli commented Jul 31, 2023

The original codefences in that document were actually partly json5 (which is among the supported languages of github), hence I thought that this is the solution. Will change back and update the code to json compliance.

@SirUli SirUli requested a review from secustor July 31, 2023 16:11
@secustor
Copy link
Collaborator

The linting fails because of the first JSON block

@SirUli
Copy link
Contributor Author

SirUli commented Aug 1, 2023

Sorry - i had the codeblock in my editor replaced but apparently not commited. Now finally done. Sorry again!

@SirUli
Copy link
Contributor Author

SirUli commented Aug 1, 2023

Hope now we got it finally, the output of the task from prettier wasn't super helpful but i believe it was the spaces in the code block.

@secustor
Copy link
Collaborator

secustor commented Aug 1, 2023

You can run yarn run lint-fix to fix most issues.
https://github.com/renovatebot/renovate/blob/main/package.json#L32

@SirUli
Copy link
Contributor Author

SirUli commented Aug 1, 2023

So instead of a quick contribution this turned into a crazy undertaking. Btw the linter wanted to have this:

# renovate: datasource=custom.nexus_generic depName=something versioning=loose
something_version: '77'

instead of

# renovate: datasource=custom.nexus_generic depName=something versioning=loose
something_version: "77"

which led to a change of the overall regex etc. Very opionated style... anyway now it should be complete finally.

@secustor secustor added this pull request to the merge queue Aug 1, 2023
Merged via the queue into renovatebot:main with commit 908777c Aug 1, 2023
34 checks passed
@SirUli
Copy link
Contributor Author

SirUli commented Aug 1, 2023

Thanks so much for your help and patience @secustor !

@secustor
Copy link
Collaborator

secustor commented Aug 1, 2023

You're welcome. Thanks for your contribution!

@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 36.27.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 2, 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.

4 participants