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

Missing fixes, docs and deprecations rework #8

Merged
merged 7 commits into from
Dec 12, 2023

Conversation

lkubb
Copy link
Member

@lkubb lkubb commented Dec 11, 2023

Some minor fixes/improvements that were not part of the PR and further cleanup.

Additionally:

  • Remove versionadded/versionchanged from previous Salt releases (irrelevant for a new project)
  • Change versionadded/versionchanged from 3007.0 to 1.0.0 to highlight the differences vs Salt core
  • Change calls to salt.utils.versions.warn_until to a local analog since we're independent from Salt releases now.
  • Ensure we have a path to migrate from some currently broken (but backwards-compatible) defaults to more sensible ones (SDB patch behavior false -> true and vault.list_secrets returning the list instead of a single-key dict {keys: [secret/keys, we/actually/asked/for]}

After this, I think the following still needs to happen before a release:

  • I remember there was an issue with timestamps and time zones. Looking into this now. Nothing to fix, it's fine.
  • Ensure we have a working changelog setup, open equivalent issues here and add them to the changelog.
  • At least make the README a bit more user-friendly. I would love to rework the docs since we're not limited to docstrings anymore, but that shouldn't be a blocker and would likely heavily benefit from user feedback/involvement. I'm far too deep in the workings of this code. :)
  • (Publish the docs at readthedocs.)
  • (Also add issue/PR templates)

... and ensure local SecretIDs are always attached
to the client to allow introspection.

The token API returns `expire_time`, while the AppRole
API uses `expiration_time`.
We don't need versionadded/versionchanged for Salt versions since we're
separate now. All changes versus Salt core are marked as added/changed
in `1.0.0`.
We're independent from Salt releases now, so act like it.
@lkubb lkubb changed the title Missing fixes Missing fixes, docs and deprecations rework Dec 11, 2023
@lkubb lkubb marked this pull request as ready for review December 11, 2023 12:24
@nicholasmhughes nicholasmhughes merged commit acdcde8 into salt-extensions:main Dec 12, 2023
13 checks passed
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