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.

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

REX MSDocs validation tool for Python #33408

Open
JimSuplizio opened this issue Dec 5, 2023 · 2 comments
Open

REX MSDocs validation tool for Python #33408

JimSuplizio opened this issue Dec 5, 2023 · 2 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team.

Comments

@JimSuplizio
Copy link
Member

Package name on pypi: py2docfx

In the pipeline, download the tool and tool to validate packages during the following parts of the build:

  • Package onboarding
  • Package metadata updates to docs repo (during release)
  • Nightly package docs validation
    Validation process today involves pulling a container image from a private container registry. This step can be removed as the tool replaces the container.

We will pin this package initially to prevent unpredictable breaks. To keep things moving forward on this, add a job to docindex which checks for a later version of the REX tool. If found:

  1. Install tool locally
  2. Test tool using the shared tests
  3. If tests pass open a PR to update the pinned version of the REX tool
@JimSuplizio JimSuplizio self-assigned this Dec 5, 2023
@JimSuplizio JimSuplizio added the Central-EngSys This issue is owned by the Engineering System team. label Dec 8, 2023
@JimSuplizio JimSuplizio moved this from 🤔 Triage to 🐝 Dev in Azure SDK EngSys 🚢🎉 Jan 2, 2024
@danieljurek
Copy link
Member

See also: #34557

@JimSuplizio JimSuplizio moved this from 🐝 Dev to 🔬 Dev in PR in Azure SDK EngSys 🚢🎉 May 3, 2024
@JimSuplizio
Copy link
Member Author

This is fixed with the merge of #38085 in the Python repository.

@kurtzeborn kurtzeborn moved this from 🔬 Dev in PR to 🎊 Closed in Azure SDK EngSys 🚢🎉 Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team.
Projects
Status: 🎊 Closed
Development

No branches or pull requests

2 participants