add docs folder which is copy that points at gh-pages URls, and setup CI build that updates them (will also add to PRs)#10
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a generated docs/ mirror of the Renovate presets/configs with local> references rewritten to GitHub Pages URLs, and introduces a GitHub Actions workflow intended to keep that mirror up to date for environments (e.g., Azure DevOps) that can’t resolve GitHub-local presets.
Changes:
- Add
docs/directory containing rewritten, GitHub Pages-hostable copies of the Renovate config/presets. - Add a GitHub Actions workflow to regenerate and (on
mainpushes) commit thedocs/mirror. - Update README to document consuming the GitHub Pages URLs.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Documents how to use the GitHub Pages-hosted mirror when local> presets can’t be resolved. |
| docs/default.json | Generated mirror of default.json for GitHub Pages consumption. |
| docs/recommended.json | Generated mirror of recommended.json with rewritten extends URLs. |
| docs/README.md | Explains that docs/ is generated and served via GitHub Pages. |
| docs/presets/enableGitSubmodules.json | Generated mirror of preset. |
| docs/presets/enableVulnerabilityAlerts.json | Generated mirror of preset. |
| docs/presets/group/githubActions.json | Generated mirror of preset. |
| docs/presets/group/python.json | Generated mirror of preset. |
| docs/presets/packages/niPython.json | Generated mirror of preset. |
| .vscode/settings.json | Adds editor settings (including Snyk org configuration). |
| .github/workflows/sync-docs.yml | Adds workflow to regenerate docs mirror and commit on main. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… CI build that updates them (will also add to PRs)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
63da9ca to
e966306
Compare
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
bkeryan
left a comment
There was a problem hiding this comment.
Approved with suggestions
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…/github.com/ni/python-renovate-config into users/mshafer/dev/support_for_https_loading
What does this Pull Request accomplish?
Copy existing configs to docs folder with a rewrite from
local>ni/python-renovate-config:defaulttohttps://ni.github.io/python-renovate-config/default.jsonto support non-PAT based fetching.Why should this Pull Request be merged?
Enable broader adoption
What testing has been done?
None, but this PR does create a PR job to update the docs in the PR branch