Skip to content

issue-59576: Properly Link Public/Private Provider Docs #59584

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.

Sign up for GitHub

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

Jump to bottom
Merged
potiuk merged 5 commits into from
Dec 22, 2025
Merged

issue-59576: Properly Link Public/Private Provider Docs #59584

potiuk merged 5 commits into from
Dec 22, 2025

Conversation

@jroachgolf84
Copy link
Collaborator

@jroachgolf84 jroachgolf84 commented Dec 17, 2025 •
edited
Loading

Description

Per #59576,

When creating a private custom provider in airflow 3, the providers pages have a non existing documentation link associated with this provider :

Here the link is :
https://apache.airflow.com/docs/custom-provider/0.0.0

The provider doc specify that :
If you want Airflow to link to documentation of your Provider in the providers page, make sure to add “project-url/documentation” metadata to your package. This will also add link to your documentation in PyPI.

This PR adds logic to properly parse the Project-url from the pyproject.toml file created for the private provider. Previously, the package-name and version were used to populate a templated URL. This prevented a user who specified their own URL from being able to leverage this URL.

The appropriate tests were added to validate this behavior. This was also tested with public providers to ensure no regression.

closes: #59576

@boring-cyborg boring-cyborg bot added area:API Airflow's REST/HTTP API area:UI Related to UI/UX. For Frontend Developers. labels Dec 17, 2025
@jroachgolf84 jroachgolf84 mentioned this pull request Dec 17, 2025
Closed
2 tasks
@jroachgolf84 jroachgolf84 marked this pull request as ready for review December 19, 2025 15:43
@jroachgolf84
Copy link
Collaborator Author

jroachgolf84 commented Dec 19, 2025

@bbovenzi, do you mind taking a peek at this PR?

@jroachgolf84 jroachgolf84 mentioned this pull request Dec 21, 2025
Closed
@jroachgolf84
Copy link
Collaborator Author

jroachgolf84 commented Dec 22, 2025

@pierrejeambrun, would you mind taking a look at this PR?

jason810496
jason810496 approved these changes Dec 22, 2025
View reviewed changes
Copy link
Member

@jason810496 jason810496 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! LGTM overall.

@potiuk potiuk added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Dec 22, 2025
@potiuk potiuk added this to the Airflow 3.1.6 milestone Dec 22, 2025
@potiuk potiuk merged commit 1d0c784 into apache:main Dec 22, 2025
126 checks passed
@potiuk
Copy link
Member

potiuk commented Dec 22, 2025

Nice

github-actions bot pushed a commit that referenced this pull request Dec 22, 2025
@jroachgolf84
[v3-1-test] issue-59576: Properly Link Public/Private Provider Docs (…
719fcca 
…#59584)

* issue-59576: Initial commit

* issue-59576: Generating models

* issue-59576: Linting Providers.tsx
(cherry picked from commit 1d0c784)

Co-authored-by: Jake Roach <116606359+jroachgolf84@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Dec 22, 2025

Backport successfully created: v3-1-test

Status Branch Result
✅ v3-1-test PR Link

@potiuk
Copy link
Member

potiuk commented Dec 22, 2025

Nice!

github-actions bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Dec 22, 2025
@jroachgolf84
[v3-1-test] issue-59576: Properly Link Public/Private Provider Docs (…
9ba4ccd 
…apache#59584)

* issue-59576: Initial commit

* issue-59576: Generating models

* issue-59576: Linting Providers.tsx
(cherry picked from commit 1d0c784)

Co-authored-by: Jake Roach <116606359+jroachgolf84@users.noreply.github.com>
potiuk pushed a commit that referenced this pull request Dec 22, 2025
@github-actions @jroachgolf84
[v3-1-test] issue-59576: Properly Link Public/Private Provider Docs (…
091b53c 
…#59584) (#59728)

* issue-59576: Initial commit

* issue-59576: Generating models

* issue-59576: Linting Providers.tsx
(cherry picked from commit 1d0c784)

Co-authored-by: Jake Roach <116606359+jroachgolf84@users.noreply.github.com>
Subham-KRLX pushed a commit to Subham-KRLX/airflow that referenced this pull request Jan 2, 2026
@jroachgolf84 @Subham-KRLX
issue-59576: Properly Link Public/Private Provider Docs (apache#59584)
5b43771 
* issue-59576: Initial commit

* issue-59576: Generating models

* issue-59576: Linting Providers.tsx
ephraimbuddy pushed a commit that referenced this pull request Jan 6, 2026
@github-actions @jroachgolf84 @ephraimbuddy
[v3-1-test] issue-59576: Properly Link Public/Private Provider Docs (…
cff9187 
…#59584) (#59728)

* issue-59576: Initial commit

* issue-59576: Generating models

* issue-59576: Linting Providers.tsx
(cherry picked from commit 1d0c784)

Co-authored-by: Jake Roach <116606359+jroachgolf84@users.noreply.github.com>
stegololz pushed a commit to stegololz/airflow that referenced this pull request Jan 9, 2026
@jroachgolf84 @stegololz
issue-59576: Properly Link Public/Private Provider Docs (apache#59584)
f6f26ef 
* issue-59576: Initial commit

* issue-59576: Generating models

* issue-59576: Linting Providers.tsx
@bugraoz93 bugraoz93 mentioned this pull request Jan 9, 2026
Closed
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@potiuk potiuk potiuk approved these changes

@jason810496 jason810496 jason810496 approved these changes

@bbovenzi bbovenzi Awaiting requested review from bbovenzi bbovenzi is a code owner

@pierrejeambrun pierrejeambrun Awaiting requested review from pierrejeambrun pierrejeambrun is a code owner

@ryanahamilton ryanahamilton Awaiting requested review from ryanahamilton ryanahamilton is a code owner

@shubhamraj-git shubhamraj-git Awaiting requested review from shubhamraj-git shubhamraj-git is a code owner

@guan404ming guan404ming Awaiting requested review from guan404ming guan404ming is a code owner

@vatsrahul1001 vatsrahul1001 Awaiting requested review from vatsrahul1001 vatsrahul1001 is a code owner

@bugraoz93 bugraoz93 Awaiting requested review from bugraoz93 bugraoz93 is a code owner

@ephraimbuddy ephraimbuddy Awaiting requested review from ephraimbuddy ephraimbuddy is a code owner

@rawwar rawwar Awaiting requested review from rawwar rawwar is a code owner

Assignees

No one assigned

Labels

area:API Airflow's REST/HTTP API area:UI Related to UI/UX. For Frontend Developers. backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch

Projects

None yet

Milestone

Airflow 3.1.6

Development

Successfully merging this pull request may close these issues.

Private Custom providers in Airflow3 are linked to non existing documentation page

3 participants

@jroachgolf84 @potiuk @jason810496