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

setup.cfg: fix packaging #245

Merged
merged 1 commit into from
Sep 7, 2021
Merged

Conversation

oliver-sanders
Copy link
Member

MB, some wash up from #230 (forgot to test packaging).

  • move options into [options] section
    • some were erroneously placed in the [metadata] section
  • move package_data patterns into MANIFEST.in file
    • allows easy inclusion of entire file trees

To test try doing a non-editable install, then take a look at the files included in the installation.

$ tree $(dirname $(python -c 'import cylc.uiserver; print(cylc.uiserver.__file__)'))

You should see:

  • The Python package and all of its modules (e.g. cylc.uiserver.app, cylc.uiserver.scripts.gui).
  • The ui/ hierarchy including .css, .js and .woff files.
  • The logo.svg file.

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Does not need tests (why?).
  • No change log entry required (why? follow-up to work that has not yet been released)
  • No documentation update required.
  • No dependency changes.

* move options into [options] section
  * some were erroneously placed in the [metadata] section
* move package_data patterns into MANIFEST.in file
  * allows easy inclusion of entire file trees
@oliver-sanders oliver-sanders added the bug Something isn't working label Sep 7, 2021
@oliver-sanders oliver-sanders added this to the cylc-uiserver 0.6.0 milestone Sep 7, 2021
@oliver-sanders oliver-sanders self-assigned this Sep 7, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #245 (2490135) into master (7b0a11c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #245   +/-   ##
=======================================
  Coverage   75.24%   75.24%           
=======================================
  Files          11       11           
  Lines         719      719           
  Branches      121      121           
=======================================
  Hits          541      541           
  Misses        153      153           
  Partials       25       25           

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 7b0a11c...2490135. Read the comment docs.

Copy link
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

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

Looks good. Tried master and this branch, both editable and non editable, and got the same final message with the test command: 13 directories, 141 files. New code looks tidier though 👍 🙆‍♂️

Copy link
Contributor

@datamel datamel left a comment

Choose a reason for hiding this comment

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

Thanks @oliver-sanders.

@oliver-sanders oliver-sanders merged commit ffc46a1 into cylc:master Sep 7, 2021
@oliver-sanders oliver-sanders deleted the packaging branch September 7, 2021 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants