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

8.0b3 installation changes #342

Merged
merged 2 commits into from
Nov 26, 2021

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Nov 24, 2021

  • Update installation instructions.
  • Document Conda Forge package outputs.
  • Pin documented Conda environments to the Cylc "release" (i.e. minor
    version).
  • Update test workflow to create the new environments.
  • Add environment (and with it a test) for mixed Conda-Forge / Anaconda
    installations.

Note: the conda tests are expected to fail at this stage, see the comment below and a link to a run where they pass.

@oliver-sanders oliver-sanders self-assigned this Nov 24, 2021
@@ -0,0 +1,8 @@
name: cylc-|release|
Copy link
Member Author

Choose a reason for hiding this comment

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

This gets replaced with the release when the file is read into the docs so we don't have to update it.

@oliver-sanders oliver-sanders force-pushed the 8.0b3-installation-changes branch 5 times, most recently from 50e2699 to 09b8de7 Compare November 25, 2021 11:05
@oliver-sanders oliver-sanders added content Addition or modification of documentation infrastructure Build system, Sphinx extensions, Deployment etc labels Nov 25, 2021
@oliver-sanders oliver-sanders force-pushed the 8.0b3-installation-changes branch 10 times, most recently from 0f303cb to 885ca92 Compare November 25, 2021 13:31
@oliver-sanders
Copy link
Member Author

oliver-sanders commented Nov 25, 2021

The "create conda environments" tests will fail at the moment because they are trying to create a Cylc 8.0rc1 environment (because Cylc Flow master is 8.0rc1).

These tests will be a little flaky since they are trying to build environments for versions which have not necessarily been released yet. These tests will only run whenever these files are changed, on release, or on request (can manually set the cylc/python versions for the latter).

Here's a run on my personal fork with the cylc-flow-version set to 8.0b3 (all passed):

https://github.com/oliver-sanders/cylc-doc/runs/4327011989?check_suite_focus=true

@oliver-sanders oliver-sanders force-pushed the 8.0b3-installation-changes branch 2 times, most recently from ac531e5 to 89a4fb1 Compare November 25, 2021 15:16
@oliver-sanders oliver-sanders mentioned this pull request Nov 25, 2021
14 tasks
@oliver-sanders oliver-sanders added this to the 8.0b3 milestone Nov 25, 2021
* Update installation instructions.
* Document Conda Forge package outputs.
* Pin documented Conda environments to the Cylc "release" (i.e. minor
  version).
* Update test workflow to create the new environments.
* Add environment (and with it a test) for mixed Conda-Forge / Anaconda
  installations.
@oliver-sanders oliver-sanders force-pushed the 8.0b3-installation-changes branch from 89a4fb1 to 01a3e4a Compare November 25, 2021 18:03
echo "# creating env from: ${env_file}"
new_env_file="$(sed 's/\(.*\)\.yml/\1-2.yml/' <<< "${env_file}")"
# substitute the python and cylc-flow versions in the env files
# TODO: add explicit python dep
Copy link
Member Author

Choose a reason for hiding this comment

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

For another day.

Copy link
Member Author

Choose a reason for hiding this comment

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

@oliver-sanders oliver-sanders requested a review from wxtim November 25, 2021 18:07
src/installation.rst Outdated Show resolved Hide resolved
src/installation.rst Outdated Show resolved Hide resolved
Copy link
Member

@wxtim wxtim left a comment

Choose a reason for hiding this comment

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

  • Read - makes sense - I've put a couple of extremely minor suggestions down, nothing that wouldn't stop me approving.
  • Built locally.
  • Read built version.
  • Would like to know if test failing because of absence of rc1 is deliberate or a mistake. -
    Encountered problems while solving: - nothing provides requested cylc-flow 8.0rc1**

@oliver-sanders
Copy link
Member Author

Would like to know if test failing because of absence of rc1 is deliberate or a mistake.

Explained by my comments above.

@wxtim wxtim self-requested a review November 26, 2021 10:38
@oliver-sanders oliver-sanders removed the request for review from hjoliver November 26, 2021 13:12
@datamel datamel self-requested a review November 26, 2021 13:55
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.

No problems found by me.

@@ -6,7 +6,9 @@
.. _Cylc User Guide: https://cylc.github.io/cylc-doc/latest/html/index.html
.. _Cylc Workflow Design Guide: https://cylc.github.io/cylc-doc/latest/html/workflow-design-guide/index.html
.. _Cylc: https://cylc.github.io/
.. _Cylc 8 Discourse Support Group: https://cylc.discourse.group/c/cylc/7-to-8/13
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm that 13 is strange, although works nicely, just looks a bit odd.

Copy link
Member Author

@oliver-sanders oliver-sanders Nov 26, 2021

Choose a reason for hiding this comment

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

Discourse topic number? Dunno.

If you take it out of the URL, Discourse puts it back.

@oliver-sanders oliver-sanders merged commit 2999f79 into cylc:master Nov 26, 2021
@oliver-sanders oliver-sanders deleted the 8.0b3-installation-changes branch November 26, 2021 15:27
This was referenced Nov 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation infrastructure Build system, Sphinx extensions, Deployment etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants