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

Docs: update reproducible builds guide #10939

Merged
merged 8 commits into from
Sep 30, 2024

Conversation

duboism
Copy link
Contributor

@duboism duboism commented Dec 1, 2023

As discussed in #10924, we propose to update the reproducible builds guide (docs/user/guides/reproducible-builds.rst). The goals are:

  • update instruction for config v2 file
  • clarify that versions in the guide are just example and not recommended
  • don't use the buggy sphinx=5.3.0 in the example

📚 Documentation previews 📚

@duboism duboism marked this pull request as ready for review December 5, 2023 21:48
@duboism duboism requested a review from a team as a code owner December 5, 2023 21:48
@duboism
Copy link
Contributor Author

duboism commented Dec 5, 2023

I finished the main proposed modifications.

However, I don't understand the "✅ Good:" badge in Pin your transitive dependencies. Any thoughts ?

Copy link
Member

@humitos humitos 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! I think it's good and ready to merge after some small changes 👍🏼

docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/user/guides/reproducible-builds.rst Show resolved Hide resolved
docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
@duboism
Copy link
Contributor Author

duboism commented Jan 10, 2024

Sorry for the delay. I commented on the various points you raised and modified the code.

@duboism
Copy link
Contributor Author

duboism commented Jan 21, 2024

Any news ?

@duboism
Copy link
Contributor Author

duboism commented Sep 5, 2024

Still no news ?

@ericholscher
Copy link
Member

This PR has conflicts -- I think because we addressed the change with the YAML file being required already. So it's probably fine to update this to just include the warning, and I'm fine to merge it.

@htech9
Copy link

htech9 commented Sep 26, 2024

@duboism You may want to fix the conflicts and address the comment above.

@duboism
Copy link
Contributor Author

duboism commented Sep 26, 2024

@htech9, sorry I was busy on other duties. I will adress that quickly.

@duboism
Copy link
Contributor Author

duboism commented Sep 29, 2024

As requested, I updated the branch to just include the warning (and an obvious typo).

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Thanks :)

@ericholscher ericholscher merged commit 6680d0e into readthedocs:main Sep 30, 2024
8 checks passed
@duboism
Copy link
Contributor Author

duboism commented Sep 30, 2024

Thanks for merging. The world is a little better now :)

@duboism duboism deleted the update_reproducible_builds branch September 30, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants