Skip to content

feat!: Bootstrap project and implement env-var provider #1

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

Merged
merged 11 commits into from
Jun 3, 2025

Conversation

bencehornak
Copy link
Contributor

@bencehornak bencehornak commented May 28, 2025

This PR

Depends on open-feature/kotlin-sdk#148

  • Creates the basic Gradle structure with the usual plugins (tried to follow the kotlin-sdk here)
  • Adds the usual Markdown files (similar to java-sdk-contrib)
  • Initializes GitHub Actions, renovate, release-please
  • Adds the env-var provider

Notes

There is ongoing work to make the Kotlin SDK multiplatform-based, see open-feature/kotlin-sdk#148. I suggest this and the other PR to be reviewed together and to build this repo against locally published artifacts of the Kotlin SDK based on the other PR.

Feel free to push to the branch, lmk if you need access to it.

To do

  • Set up GitHub Actions (might need tweaking due to the new KMP platforms)
  • Set up Renovate -> HELP NEEDED
  • Set up Release-Please -> will be done in Configure Release-please #2
  • Set up publishing -> HELP NEEDED
  • Set up FOSS score? -> would do later to keep this PR small
  • Decide and document supported KMP platforms of the env-provider
  • Double check OWNERS -> I just took the list from the community project, but we need the consent of the maintainers to assume the maintainer role of this repo -> HELP NEEDED
  • Review GitHub repo settings

... let me know, if further points are missing, I can add them to the list.

How to test

As far as the env-var provider is concerned I'm planning to create a KMP example app as part of open-feature/kotlin-sdk#148, we can make use of that to test it.

There are many other things to test, mainly the CI and the publishing, we will surely notice problems with those.

Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

I've only made it part way through the review but I wanted to leave some initial thoughts.

Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

Thanks for getting this started, @bencehornak! Let's see what @toddbaert says about the Release Please config.

Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

Hey @bencehornak, could you please remove the Release Please config from this PR and open a separate issue? It will take a bit to get that setup and I don't want to hold up this PR.

Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
@bencehornak
Copy link
Contributor Author

@beeme1mr done, I have moved the Release-please files to #2, please feel free to take it over from me.

Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
@bencehornak
Copy link
Contributor Author

The ci.yaml GH Actions pipeline hasn't run, I'm not sure why... it's not waiting for maintainer approval as far as I can tell.

@beeme1mr
Copy link
Member

beeme1mr commented Jun 3, 2025

The ci.yaml GH Actions pipeline hasn't run, I'm not sure why... it's not waiting for maintainer approval as far as I can tell.

I believe this is a security mechanism in GitHub to prevent people from leaking secrets. It should run for future PRs once this has been merged.

I'm going to get this in now. Thanks @bencehornak for your hard work.

@beeme1mr beeme1mr merged commit e69e9e8 into open-feature:main Jun 3, 2025
1 check 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.

3 participants