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

Update config docs and release workflow #111

Merged
merged 5 commits into from
Dec 4, 2023

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Dec 4, 2023

Proposed changes

The release workflow was updated to add a summary showing the release level for easier review during the release process. The docs were also updated with a better example showing how to use a dataclass to update the config options.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@nfelt14 nfelt14 requested a review from a team as a code owner December 4, 2023 18:35
@tek-githubbot-1010 tek-githubbot-1010 requested a review from a team December 4, 2023 18:36
Copy link

codecov bot commented Dec 4, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a18cc9f) 100.00% compared to head (44b4a17) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #111   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          168       168           
  Lines         3776      3776           
  Branches       649       649           
=========================================
  Hits          3776      3776           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nfelt14 nfelt14 added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 4, 2023
@nfelt14 nfelt14 enabled auto-merge (squash) December 4, 2023 18:58
@nfelt14 nfelt14 merged commit 9deab77 into main Dec 4, 2023
37 checks passed
@nfelt14 nfelt14 deleted the nfelt14/update-config-docs-and-release-workflow branch December 4, 2023 19:55
qthompso pushed a commit to qthompso/tm_devices that referenced this pull request Feb 15, 2024
* ci: Bump commitizen pre-commit version.

* ci: Add new job to the official release workflow that will add a summary with the release level input to make reviewing a deployment easier.

* ci: Bump pypa/gh-action-pypi-publish from 1.8.10 to 1.8.11.

* docs: Add a code example of passing in config options in a dataclass via a keyword argument when initializing the `DeviceManager`.

* docs: Add email address to security policy.

Signed-off-by: qthompso <[email protected]>
qthompso pushed a commit to qthompso/tm_devices that referenced this pull request Feb 16, 2024
* ci: Bump commitizen pre-commit version.

* ci: Add new job to the official release workflow that will add a summary with the release level input to make reviewing a deployment easier.

* ci: Bump pypa/gh-action-pypi-publish from 1.8.10 to 1.8.11.

* docs: Add a code example of passing in config options in a dataclass via a keyword argument when initializing the `DeviceManager`.

* docs: Add email address to security policy.
v12ganesh pushed a commit to v12ganesh/tm_devices that referenced this pull request Mar 28, 2024
* ci: Bump commitizen pre-commit version.

* ci: Add new job to the official release workflow that will add a summary with the release level input to make reviewing a deployment easier.

* ci: Bump pypa/gh-action-pypi-publish from 1.8.10 to 1.8.11.

* docs: Add a code example of passing in config options in a dataclass via a keyword argument when initializing the `DeviceManager`.

* docs: Add email address to security policy.
Signed-off-by: v12ganesh [email protected]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants