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.

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

Document additional Trusted Publishers #15192

Merged
merged 35 commits into from
Apr 17, 2024
Merged

Document additional Trusted Publishers #15192

merged 35 commits into from
Apr 17, 2024

Conversation

di
Copy link
Member

@di di commented Jan 11, 2024 •
edited
Loading

(recreating #15179 as a branch on this repo so we can make PRs against it here)

These sections are all empty for now; we'll fill them out as we complete each Trusted Publisher's provider implementation.

Trackers:

With each of these, the following is needed for their documentation:

  • Each needs to be merged with a per-provider admin flag disabled, so that users can't yet access it
  • Each needs to be enabled on TestPyPI so we can experiment + write their specific docs

@di di mentioned this pull request Jan 11, 2024
Closed
3 tasks
@di di mentioned this pull request Jan 11, 2024
Merged
di and others added 6 commits January 11, 2024 23:42
@di
Fix asset links
f75bc65
@di
Update admonition to match
a973d38
@di
Remove unnecessary quoting
f849aee
@di @facutuesca @woodruffw
Google Trusted Publishing docs (#15195)
656637e 
* Google Trusted Publishing docs

* Update docs/user/trusted-publishers/security-model.md

Co-authored-by: Facundo Tuesca <[email protected]>

* Update docs/user/trusted-publishers/security-model.md

Co-authored-by: Facundo Tuesca <[email protected]>

* Apply suggestions from code review

Co-authored-by: William Woodruff <[email protected]>

* Apply suggestions from code review

---------

Co-authored-by: Facundo Tuesca <[email protected]>
Co-authored-by: William Woodruff <[email protected]>
@di
Add Google screenshots
0bfd2fc
@di
Fix provider-specific screenshots
fc699e0
@di
Copy link
Member Author

di commented Jan 13, 2024

OK, I think the Google docs are good here.

FYI, what I'm doing to keep the screenshots consistent is going to the sections I added in #15193 in the Chrome inspector, right clicking and doing "Capture node screenshot".

Looking at the docs now, we might want to add some padding & a border around screenshots, because in light mode they look a lot like out docs text, and in dark mode there isn't enough padding.

@woodruffw woodruffw mentioned this pull request Jan 25, 2024
Merged
1 task
@woodruffw woodruffw self-assigned this Jan 25, 2024
@woodruffw woodruffw mentioned this pull request Jan 25, 2024
Closed
8 tasks
@facutuesca facutuesca mentioned this pull request Jan 26, 2024
Merged
@woodruffw
Copy link
Member

ActiveState has fully landed as well, so we need a PR against this branch for its docs (cc @th3coop)

@di
Copy link
Member Author

di commented Feb 23, 2024

Hey @th3coop, friendly ping here to see if you'll be able to add the ActiveState docs!

@facutuesca
Add GitLab Trusted Publishing docs (#15283)
db9c99b 
* Add GitLab Trusted Publishing docs

* Add screenshots to GitLab Trusted Publishing docs

* Fix instructions for GitLab CI with Trusted Publishing
@th3coop
Copy link
Contributor

th3coop commented Feb 23, 2024

Hey @di! Someone is working on a PR for this right now. Possibly ready today, more likely next week. Is that timing ok? I'm coordinating with PeteG btw.

@di
Copy link
Member Author

di commented Feb 23, 2024

Sure that works! Our goal is to have this launched by PyCon US at the very latest, but ideally sooner.

@th3coop
Copy link
Contributor

th3coop commented Feb 23, 2024

Sounds good. Thanks for the heads up @di!

@th3coop
Copy link
Contributor

th3coop commented Mar 6, 2024

@di or @woodruffw, could either of you update this branch with master to get the ActiveState OIDC code into the branch?

@di
Copy link
Member Author

di commented Mar 6, 2024

@th3coop Done!

@di di mentioned this pull request Mar 7, 2024
Closed
2 tasks
th3coop and others added 2 commits March 20, 2024 11:41
@th3coop @rawktron
@woodruffw @di
Add activestate OIDC docs (#15548)
b9b1532 
* First draft of ActiveState Trusted Publishing docs

* Add ActiveState Security Model and Considerations

* Adding examples

* Add link to ActiveState hosted OIDC docs

* Add updated docs from Andrew

* MD tweaks and some images

* Add remaining screenshots and embbed them in MD

* Tweaking instructions for publishing

* Update warehouse/templates/manage/account/publishing.html

Co-authored-by: William Woodruff <[email protected]>

* Review edit

Co-authored-by: Dustin Ingram <[email protected]>

* Review edits

Co-authored-by: Dustin Ingram <[email protected]>

* Review edits

Co-authored-by: Dustin Ingram <[email protected]>

* Review edits

Co-authored-by: Dustin Ingram <[email protected]>

* Review edits

Co-authored-by: Dustin Ingram <[email protected]>

* Translations

* Fix build script tokens, link to supported platforms

* Revise and reformat ActiveState using instructions

---------

Co-authored-by: Pete Garcin <[email protected]>
Co-authored-by: William Woodruff <[email protected]>
Co-authored-by: Dustin Ingram <[email protected]>
@di
Slugify tab anchors
8cc6ee5
@di di mentioned this pull request Mar 22, 2024
Merged
di and others added 5 commits March 22, 2024 12:38
@di @miketheman
Add blogpost announcing more trusted publishers (#15656)
6f1c8b2 
* Fix old byline

* Add blogpost announcing more trusted publishers

* Update docs/blog/posts/2024-04-20-expanding-trusted-publisher-support.md

Co-authored-by: Mike Fiedler <[email protected]>

* Apply suggestions from code review

---------

Co-authored-by: Mike Fiedler <[email protected]>
@di
Merge branch 'main' into more-oidc-docs
a5f0e0b
@rawktron @di
Updating ActiveState publishing docs (#15739)
0b75a2d 
* Updating ActiveState publishing docs

* Update docs/user/trusted-publishers/using-a-publisher.md

Co-authored-by: Dustin Ingram <[email protected]>

---------

Co-authored-by: Dustin Ingram <[email protected]>
@di
Update publish date
b5fb60d
@di
Merge branch 'main' into more-oidc-docs
d9c6e7e
@di di marked this pull request as ready for review April 10, 2024 17:01
@di di requested a review from a team as a code owner April 10, 2024 17:01
@di
Copy link
Member Author

di commented Apr 10, 2024

@pypi/warehouse-committers This is ready for review, with an anticipated publish date of Monday, April 15th!

miketheman
miketheman approved these changes Apr 10, 2024
View reviewed changes
Copy link
Member

@miketheman miketheman left a comment

Choose a reason for hiding this comment

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

I skimmed some of the instructions, but generally looks good. I dropped a fair amount of notes, feel free to accept/reject them as needed for this rollout.

warehouse/templates/manage/account/publishing.html Show resolved Hide resolved
docs/user/trusted-publishers/using-a-publisher.md Show resolved Hide resolved
docs/user/trusted-publishers/using-a-publisher.md Outdated Show resolved Hide resolved
docs/user/trusted-publishers/adding-a-publisher.md Outdated Show resolved Hide resolved
docs/user/assets/trusted-publishing/activestate/pending-publisher-registered.png Outdated Show resolved Hide resolved
docs/user/trusted-publishers/creating-a-project-through-oidc.md Outdated Show resolved Hide resolved
docs/user/trusted-publishers/security-model.md Show resolved Hide resolved
docs/user/trusted-publishers/security-model.md Show resolved Hide resolved
docs/user/trusted-publishers/using-a-publisher.md Outdated Show resolved Hide resolved
docs/user/trusted-publishers/using-a-publisher.md Outdated Show resolved Hide resolved
miketheman
miketheman approved these changes Apr 10, 2024
View reviewed changes
Copy link
Member

@miketheman miketheman left a comment

Choose a reason for hiding this comment

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

I skimmed some of the instructions, but generally looks good. I dropped a fair amount of notes, feel free to accept/reject them as needed for this rollout.

@di di merged commit b00ec3e into main Apr 17, 2024
17 checks passed
@di di deleted the more-oidc-docs branch April 17, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@th3coop th3coop th3coop left review comments

@rawktron rawktron rawktron left review comments

@miketheman miketheman miketheman approved these changes

Assignees

@woodruffw woodruffw

Labels
documentation trusted-publishing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@di @woodruffw @th3coop @miketheman @rawktron @facutuesca