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

Add documentation on updating Octue services #683

Merged
merged 16 commits into from
Oct 25, 2024
Merged

Conversation

cortadocodes
Copy link
Member

@cortadocodes cortadocodes commented Oct 23, 2024

Contents (#683)

Operations

  • Use latest ruff pre-commit check

Dependencies

  • Add ruff to dev dependencies

Other

  • Add doc on updating an Octue service

@cortadocodes cortadocodes self-assigned this Oct 23, 2024
docs/source/updating_services.rst Outdated Show resolved Hide resolved
docs/source/updating_services.rst Outdated Show resolved Hide resolved

6. Write any new tests you need to verify your code works and update any old tests as needed

7. Run the tests locally using e.g. ``pytest`` or ``python -m unittest``
Copy link
Contributor

Choose a reason for hiding this comment

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

Consolidate on pytest. It should be in a code block so it gets formatted similarly to previous steps.

Note: we should start installing it as a dev dependency by default.

Copy link
Contributor

Choose a reason for hiding this comment

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

oooh double note, we should have a pytest-octue module containing all our test code ;)

Copy link
Contributor

Choose a reason for hiding this comment

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

you could have a screenshot of pytest output in the terminal, you want all green ticks ;)

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you mean test code for the SDK or some kind of generalisable test helpers?

Copy link
Member Author

@cortadocodes cortadocodes Oct 25, 2024

Choose a reason for hiding this comment

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

I've got a screenshot from amy - I think that's ok? It doesn't reveal anything private apart from test paths

docs/source/updating_services.rst Outdated Show resolved Hide resolved
docs/source/updating_services.rst Outdated Show resolved Hide resolved
docs/source/updating_services.rst Outdated Show resolved Hide resolved
docs/source/updating_services.rst Outdated Show resolved Hide resolved
docs/source/updating_services.rst Outdated Show resolved Hide resolved
docs/source/updating_services.rst Outdated Show resolved Hide resolved
docs/source/updating_services.rst Show resolved Hide resolved
@thclark thclark merged commit 8fb10ce into main Oct 25, 2024
5 checks passed
@thclark thclark deleted the add-updating-service-docs branch October 25, 2024 11:48
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.

2 participants