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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info to README about layered requirements files #905

Merged
merged 4 commits into from
Sep 25, 2019
Merged

Add info to README about layered requirements files #905

merged 4 commits into from
Sep 25, 2019

Conversation

jamescooke
Copy link
Contributor

@jamescooke jamescooke commented Sep 22, 2019

Hopefully fixes #398 馃

Changelog-friendly one-liner: Add info to README about layered requirements files and -c flag

Contributor checklist

Not sure how to address these - sorry...

  • Provided the tests for the changes.
  • Requested a review from another contributor.
  • Gave a clear one-line description in the PR (that the maintainers can add to CHANGELOG.md on release).
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

@jamescooke
Copy link
Contributor Author

This is broken because master is broken 馃槥

Latest PR that seems to have introduced the breakage is here: #864

Bump me when master is green again and I can merge the fixes.

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for your contribution! Please, consider grammar comments as minor, for I'm not a native speaker.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@atugushev
Copy link
Member

atugushev commented Sep 22, 2019

This is broken because master is broken 馃槥

Latest PR that seems to have introduced the breakage is here: #864

Looks like I've forgotten to mark pip19.3 as allowed to fail.

@atugushev atugushev added this to the 4.2.0 milestone Sep 22, 2019
@atugushev atugushev added the docs Documentation related label Sep 23, 2019
Co-Authored-By: Albert Tugushev <albert@tugushev.ru>
@codecov
Copy link

codecov bot commented Sep 23, 2019

Codecov Report

Merging #905 into master will decrease coverage by 0.48%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #905      +/-   ##
==========================================
- Coverage   99.06%   98.57%   -0.49%     
==========================================
  Files          35       35              
  Lines        2247     2247              
  Branches      288      288              
==========================================
- Hits         2226     2215      -11     
- Misses         13       21       +8     
- Partials        8       11       +3
Impacted Files Coverage 螖
piptools/repositories/pypi.py 91.21% <0%> (-3.91%) 猬囷笍
piptools/utils.py 97.95% <0%> (-2.05%) 猬囷笍

Continue to review full report at Codecov.

Legend - Click here to learn more
螖 = absolute <relative> (impact), 酶 = not affected, ? = missing data
Powered by Codecov. Last update 53c0742...2c8f00a. Read the comment docs.

Co-Authored-By: Albert Tugushev <albert@tugushev.ru>
@jamescooke
Copy link
Contributor Author

@atugushev Thanks for all the suggestions - I've merged them all in.

Just waiting for the master fix now (#906) 馃憤

@atugushev
Copy link
Member

atugushev commented Sep 23, 2019

@jamescooke

Thanks for addressing my review comments! Could you please also add a "Changelog-friendly one-liner" to the issue text?

@jamescooke
Copy link
Contributor Author

@atugushev NP. Thanks for helping me on this PR 馃憤

I have added the one-liner to the description - hope it's suitable.

@atugushev
Copy link
Member

Great! I'm going to merge this, despite failing CI, since the TOXENV=readme CI job is green.

@atugushev atugushev merged commit 4b29e07 into jazzband:master Sep 25, 2019
@atugushev
Copy link
Member

@jamescooke thank you so much for working on this! Appreciate it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Workflow for layered requirements (e.g. prod<-test<-dev requirements)?
2 participants