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

Implement changes for v0.1.1 release #15

Merged
merged 13 commits into from
Nov 12, 2021
Merged

Conversation

Mandrenkov
Copy link
Collaborator

Context:
A patch release of the XCC is required to address some integration troubles with Strawberry Fields.

Description of the Change:

  • Updated the XCC version to 0.1.1.
  • On Windows, the XCC configuration file is now stored at ...\Xanadu\xanadu-cloud\.env.
  • The Job class now has a metadata property for accessing information about job failures.
  • GitHub Actions workflows are now triggered when a branch is merged into main.
  • Individual modules are now listed in the API section of the Sphinx sidebar.
  • The Settings class docstring has been expanded and updated with a tutorial.
  • The xcc config set help text has been updated with a refresh token example.

Benefits:

  • The .env configuration file is stored in a more familiar directory structure on Windows.
  • Strawberry Fields can access job failure information without accessing the private Job._details member.
  • The Sphinx and CLI documentation is more accessible and useful.

Possible Drawbacks:

  • Users that have configured the XCC on Windows will need to reapply their settings.

Related GitHub Issues:
None.

Copy link

@thisac thisac 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 to me! 💯

Locally, there seems to be an issue with the Job docs example rendering, as well as the Settings docstring not updating. Is probably just on my side though, but worth checking.

xcc/commands.py Outdated Show resolved Hide resolved
Copy link

@trbromley trbromley left a comment

Choose a reason for hiding this comment

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

💯


### Bug Fixes

* On Windows, the XCC configuration file is now stored at `...\Xanadu\xanadu-cloud\.env`.

Choose a reason for hiding this comment

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

Do we need the ...?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Maybe? I just wanted to communicate that the configuration file is not stored in the relative directory

Xanadu\xanadu-cloud\.env

@Mandrenkov Mandrenkov merged commit 7f7f3f4 into main Nov 12, 2021
@Mandrenkov Mandrenkov deleted the sc-11178-patch-release-0.1.1 branch November 12, 2021 21:44
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.

3 participants