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: guide about reproducible builds #7888

Merged
merged 4 commits into from Mar 8, 2021
Merged

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Feb 2, 2021

Tried to keep it short, simple and easy to copy/pasta, I think this replaces the other guide.

Close #7852

@Pradhvan
Copy link
Contributor

Pradhvan commented Feb 21, 2021

@stsewd happy to collaborate with you here. 😄

I and @ericholscher discussed a basic outline for the guide in the PyCascades 2021 sprints. Feel free to look into it in the issue and suggest more changes to it.

@eric-wieser
Copy link
Contributor

I find that implausible given that I didn't attend PyCascades 2021 and haven't lived near the cascades for over a year!

@Pradhvan
Copy link
Contributor

I find that implausible given that I didn't attend PyCascades 2021 and haven't lived near the cascades for over a year!

Sorry 😅 @eric-wieser I mistakenly tagged you. Updated the original comment.

@Pradhvan
Copy link
Contributor

@stsewd if you are busy with something else I would be happy to continue(update the same PR) with the guide and you can review it when I am done with the PR with the point mentioned in the issue.

Does that sound good to you?

@stsewd
Copy link
Member Author

stsewd commented Feb 23, 2021

@stsewd if you are busy with something else I would be happy to continue(update the same PR) with the guide and you can review it when I am done with the PR with the point mentioned in the issue.

Does that sound good to you?

Sure! Feel free to send a PR with this as base so is easy to review your changes

- conda-forge
- defaults
dependencies:
- sphinx==3.4.3
Copy link
Contributor

Choose a reason for hiding this comment

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

If I understand correctly, core dependencies can't be pinned in conda environment files at the moment, right? #3829

Copy link
Contributor

Choose a reason for hiding this comment

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

I just tried it again to be sure, Sphinx gets overridden https://readthedocs.org/projects/rtd-conda-test/builds/13122163/

Copy link
Member

Choose a reason for hiding this comment

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

They can be pinned. However, CONDA_APPEND_CORE_REQUIREMENTS feature flag has to be enabled in the project by the core team: https://docs.readthedocs.io/en/stable/guides/feature-flags.html#feature-flags

Copy link
Member

Choose a reason for hiding this comment

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

BTW, for future build tests, we have this repository https://github.com/readthedocs/test-builds where we have one test case per branch (properly named) with the use case that it's testing described in the homepage/index 😉

(you can create a PR instead of a branch since you don't have permissions)

Copy link
Member Author

Choose a reason for hiding this comment

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

They can be pinned. However, CONDA_APPEND_CORE_REQUIREMENTS feature flag has to be enabled in the project by the core team

I'm tempted to add a note about that here, but I think maybe we should push to make that the default.

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.

This is a great improvement. Let's ship it!

docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
stsewd and others added 3 commits March 8, 2021 12:33
@stsewd stsewd enabled auto-merge (squash) March 8, 2021 17:48
@stsewd stsewd merged commit 9af02e6 into master Mar 8, 2021
@stsewd stsewd deleted the guide-reproducible-builds branch March 8, 2021 17:50
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.

Write better requirements guide
6 participants