renovatebot/renovate

Update documentation that covers `daniel-shuy/renovate` Circle CI Orb

Open

#13,428 opened on Jan 8, 2022

View on GitHub
 (3 comments) (1 reaction) (0 assignees)TypeScript (1,916 forks)batch import
core:docshelp wantedpriority-4-low

Repository metrics

Stars
 (14,066 stars)
PR merge metrics
 (Avg merge 2d 23h) (339 merged PRs in 30d)

Description

Describe the proposed change(s).

Affected page: https://docs.renovatebot.com/examples/self-hosting/#circleci

The 3.0.0 version of the daniel-shuy/renovate Orb has breaking changes 1:

Move self-hosted configuration file validation to a new validate-self-hosted-config job. This is a breaking change. If you were using the validate-config job to validate self-hosted configuration files, use the new validate-self-hosted-config job instead.

If we want to bump the version of the Orb in our docs to the latest 3.x range, we should update our docs/examples as well, I think.

This issue is to get help on what we should change in the docs, as I don't use this Orb or Circle CI. 😉

Found this issue while working on PR #13426.

Footnotes

  1. https://github.com/daniel-shuy/renovate-orb/releases ↩

Contributor guide

Research direction
Review the breaking changes in the daniel shuy/renovate orb v3.0.0 release notes linked in the issue. Update the CircleCI self hosting documentation page to reflect the new validate self hosted config job and bump the orb version to 3.x. Ensure the example config uses the correct job names and parameters.
Tech stack
typescript
Domain
devops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75