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

fix(platform): fix types and docs #19944

Merged
merged 10 commits into from Jan 24, 2023
Merged

fix(platform): fix types and docs #19944

merged 10 commits into from Jan 24, 2023

Conversation

viceice
Copy link
Member

@viceice viceice commented Jan 20, 2023

Changes

  • fix PlatformId usage
  • update Gitea docs for git clone filters
  • sort platform listings in docs

Context

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

lib/modules/platform/gitea/index.md Outdated Show resolved Hide resolved
lib/config/presets/local/index.ts Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
lib/modules/platform/gitea/index.md Outdated Show resolved Hide resolved
GitLab and Gitea implement draft status by checking if the PR's title starts with certain strings.
This means that `draftPR` on GitLab and Gitea are incompatible with the legacy method of triggering Renovate to rebase a PR by renaming the PR to start with `rebase!`.
Gitea and GitLab implement draft status by checking if the PR's title starts with certain strings.
This means that `draftPR` on Gitea and GitLab are incompatible with the legacy method of triggering Renovate to rebase a PR by renaming the PR to start with `rebase!`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Sentence too long

This sentence is too long and tries to explain too much at once. The key points seem to be:

  • Because Gitea and GitLab have a different method of checking if a PR is draft, the draftPR feature doesn't work as expected.
  • You can't use the legacy method of triggering Renovate by prefixing the PR with the text rebase!.

Why are we mentioning a "legacy method"

If the method is "legacy" why do we mention it? People can use the Dependency Dashboard to request a rebase, but maybe that doesn't work on the affected platforms?

Maybe we can streamline the sentence by dropping the reference to the legacy method?

Copy link
Member Author

Choose a reason for hiding this comment

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

make a suggestion, otherwise i would like to shift this to a seperate pr. Intension was to order platforms

rarkins
rarkins previously approved these changes Jan 24, 2023
@rarkins rarkins enabled auto-merge (squash) January 24, 2023 07:10
@rarkins rarkins disabled auto-merge January 24, 2023 09:05
@rarkins rarkins merged commit 9bd857c into main Jan 24, 2023
@rarkins rarkins deleted the fix/typings branch January 24, 2023 09:05
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 34.112.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

4 participants