Add a reusable official “Powered by papermill” SVG badge asset#875
Add a reusable official “Powered by papermill” SVG badge asset#875huyhoang171106 wants to merge 3 commits intonteract:mainfrom
Conversation
Signed-off-by: Nguyen Huy Hoang <181364121+huyhoang171106@users.noreply.github.com>
Signed-off-by: Nguyen Huy Hoang <181364121+huyhoang171106@users.noreply.github.com>
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Pull request overview
Adds a first-party “Powered by papermill” SVG badge to the repo and surfaces it in the README so downstream projects can reference a stable in-repo asset rather than third-party badge generators.
Changes:
- Added
docs/_static/images/powered-by-papermill.svgbadge asset (label/value + logo mark). - Updated
README.mdto include the new badge.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/_static/images/powered-by-papermill.svg | Introduces the reusable SVG badge asset under docs static images. |
| README.md | Adds a Markdown badge pointing at the new SVG (but the file content appears unintentionally overwritten/truncated). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -15,6 +15,7 @@ | ||
| [](https://snyk.io/advisor/python/papermill) | ||
| [](https://anaconda.org/conda-forge/papermill) |
There was a problem hiding this comment.
README.md appears to have been accidentally overwritten/truncated: it now starts with a literal diff hunk marker (@@ -15,6 +15,7 @@) and most of the README content has been removed. For this PR’s stated goal (add an in-repo badge asset), the README should retain its existing content and only add the new badge line.
| [](https://snyk.io/advisor/python/papermill) | ||
| [](https://anaconda.org/conda-forge/papermill) | ||
| [](https://results.pre-commit.ci/latest/github/nteract/papermill/main) | ||
| +[](https://github.com/nteract/papermill) |
There was a problem hiding this comment.
The new badge image URL hardcodes the main branch (raw.githubusercontent.com/.../main/...). If the intent is a stable, versioned badge URL for downstream projects, consider using a relative path in the README (so it works on forks/branches) and/or documenting a tag-based raw URL pattern for consumers rather than pointing at main.
| +[](https://github.com/nteract/papermill) | |
| +[](https://github.com/nteract/papermill) |
Summary
Create a first-party SVG badge in-repo so downstream projects can use a stable, versioned badge URL instead of ad-hoc shields.io text-only badges. The badge should include a left label (“powered by”) and a right value (“papermill”), plus the papermill logo mark sourced from the nteract logos repository (as referenced in the issue comments), so users can display a branded badge.
Files changed
docs/_static/images/powered-by-papermill.svg(new)README.md(modified)Testing
What does this PR do?
Fixes #<issue_number>
Closes #718