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

feat(proto): Add unspecified to enum fields #98

Merged
merged 3 commits into from
Jun 17, 2020
Merged

feat(proto): Add unspecified to enum fields #98

merged 3 commits into from
Jun 17, 2020

Conversation

ezimanyi
Copy link
Contributor

  • style(test): Sort halconfig file

    It's easier to find fields if it's sorted.

    Also while making trivial changes, format the markdown files with prettier.

  • feat(security): Remove unused enum

    This enum was only used by Halyard to track they type of OAuth provider you had configured; it used this to set other fields when you ran hal commands.

    A while back I updated the documentation on spinnaker.io to show users how to set the required fields themselves (which is useful both for directly editing your hal config with Halyard, or for early adopters of kleat).

    We can remove this field as it is not used. I'll add a note to the changelog about this. Existing Halyard users would already have had the other fields filled out based on that field when they ran hal commands, so I'm not including this as a breaking change. New users will need to set their config fields themselves using the documentation on spinnaker.io.

  • feat(proto): Add unspecified to enum fields

    We want to distinguish unspecified enums from enums set to their default value. Let's do this by making the default value in each enum be a sentinel UNSPECIFIED value. This means that when the field is not specified, it will be deseriazlied as UNSPECIFIED, and will be omitted from re-serialization. Any valid value will be included in serialization.

ezimanyi added 3 commits June 16, 2020 17:46
It's easier to find fields if it's sorted.

Also while making trivial changes, format the markdown files
with prettier.
This enum was only used by Halyard to track they type of OAuth
provider you had configured; it used this to set other fields
when you ran hal commands.

A while back I updated the documentation on spinnaker.io to
show users how to set the required fields themselves (which is
useful both for directly editing your hal config with Halyard, or
for early adopters of kleat).

We can remove this field as it is not used. I'll add a note to the
changelog about this. Existing Halyard users would already have had
the other fields filled out based on that field when they ran hal
commands, so I'm not including this as a breaking change. New users
will need to set their config fields themselves using the documentation
on spinnaker.io.
We want to distinguish unspecified enums from enums set to their
default value. Let's do this by making the default value in each
enum be a sentinel UNSPECIFIED value. This means that when the
field is not specified, it will be deseriazlied as UNSPECIFIED,
and will be omitted from re-serialization. Any valid value will
be included in serialization.
@ezimanyi ezimanyi requested a review from maggieneterval as a code owner June 16, 2020 22:02
Copy link
Contributor

@maggieneterval maggieneterval left a comment

Choose a reason for hiding this comment

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

❓ 📧 #️⃣ 📝 ✅

@maggieneterval maggieneterval merged commit 1754772 into spinnaker:master Jun 17, 2020
@ezimanyi ezimanyi deleted the optional-enums branch June 17, 2020 16:20
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