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

Avoid requiring jupyter_config.py in to be in uiserver subdirectory #594

Draft
wants to merge 1 commit into
base: 1.5.x
Choose a base branch
from

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented May 9, 2024

Closes #565

Previously it was assumed to be in CYLC_SITE_CONF_PATH/uiserver.

Ensure that user is warned if file at CYLC_SITE_CONF_PATH is

  • Unreadable
  • Non-existent

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).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • CHANGES.md entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

…erver

Remove the need for the uiserver subdirectory.
Ensure that user is warned if file at CYLC_SITE_CONF_PATH is
* Unreadable
* Non-existent
@wxtim wxtim force-pushed the fix.respect_CYLC_SITE_CONF_PATH branch from ac02b14 to 00708ae Compare May 9, 2024 09:15
@wxtim wxtim self-assigned this May 9, 2024
@wxtim wxtim added the small label May 9, 2024
@wxtim wxtim removed the request for review from markgrahamdawson May 9, 2024 09:16
@wxtim wxtim added this to the 1.4.5 milestone May 9, 2024
@MetRonnie MetRonnie modified the milestones: 1.4.5, 1.5.1 Jun 18, 2024
@MetRonnie MetRonnie changed the base branch from 1.4.x to 1.5.x June 19, 2024 12:43
@oliver-sanders oliver-sanders modified the milestones: 1.5.1, 1.6.0 Oct 15, 2024
Copy link
Member

@oliver-sanders oliver-sanders left a comment

Choose a reason for hiding this comment

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

Previously it was assumed to be in CYLC_SITE_CONF_PATH/uiserver.

This was correct and consistent with cylc-flow which looks in $CYLC_SITE_CONF_PATH/flow.

The CYLC_SITE_CONF_PATH directory is supposed to look like this:

.
|-- flow
|   `-- global.cylc
`-- uiserver
    `-- jupyter_config.py

The intention is that it can be used to configure all of the Cylc components.

As of the current versions setting CYLC_SITE_CONF_PATH to the root of the above structure works fine for me.

@wxtim
Copy link
Member Author

wxtim commented Oct 15, 2024

As of the current versions setting CYLC_SITE_CONF_PATH to the root of the above structure works fine for me.

So this can be closed?

@oliver-sanders
Copy link
Member

Check the issue.

@wxtim wxtim marked this pull request as draft October 16, 2024 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

UI Server Configuration does not seem to honour $CYLC_SITE_CONF_PATH environment variable
3 participants