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

Unify ospo-actions configuration #74

Open
ahpook opened this issue Mar 18, 2024 · 3 comments
Open

Unify ospo-actions configuration #74

ahpook opened this issue Mar 18, 2024 · 3 comments
Labels
enhancement New feature or request ospo-actions Issues relating to the OSPO Actions

Comments

@ahpook
Copy link
Contributor

ahpook commented Mar 18, 2024

Currently, the various ospo actions are completely independent. But users who adopt several of them end up restating a lot of configuration for them which would ideally be centralized. As concrete examples, setting:

  • a list of repositories to ignore from reporting, or conversely a list of ones to only report
  • whether to execute in dry run mode or not
  • output formats / destinations that are not the default
  • ... probably others ...

would be better served by a common configuration file that all of the actions know to look for.

@ahpook ahpook converted this from a draft issue Mar 18, 2024
@ahpook ahpook added the ospo-actions Issues relating to the OSPO Actions label Mar 19, 2024
@jmeridth
Copy link
Member

@ahpook

I like this idea.

A thought and a couple questions:

Thought:

  • a central ~/.githubospo (not married to the name) file that has all the contents from each repositories .env-sample or README environment variables (some are not in the samples currently) in there. Like asked above, if exists, it will be used and then fall back to repo directory .env file.

Questions:

  • you mean this from a contributor's perspective, correct? When a developer is working on a pull request locally each action could look for the "centralized" environment variable file and use it if it exists, otherwise fall back to the repo's .env file. I ask this because when the actions run they will be told where the environment variables are located, usually in repo secrets (e.g, ${{ secrets.GH_APP_ID }})
  • do we want to do one or the other regarding parsing (either ~/.githubospo or repo_dir/.env)? Or do we parse from both. I prefer the former, easier to manage. Otherwise you have to set expectation on presidence re: overwrites (i.e, GH_APP_ID is in ~/.githubospo and also in repo_dir/.env, which has presidence?)

@jmeridth
Copy link
Member

I'm also looking at possibly doing a composite GitHub action for env handling https://docs.github.com/en/actions/creating-actions/creating-a-composite-action

@lelia
Copy link

lelia commented Apr 5, 2024

https://docs.github.com/en/actions/creating-actions/creating-a-composite-action

I'd definitely be in support of this!

@ahpook ahpook added the enhancement New feature or request label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ospo-actions Issues relating to the OSPO Actions
Projects
Status: Backlog
Development

No branches or pull requests

3 participants