Skip to content

docs: add example configuration for Windows-based runners #1268

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

zillemarco
Copy link
Contributor

Added an example configuration to use the module to set up Windows-based runners and an example on how to create a custom Windows AMI usable with the configuration.

Copy link
Contributor

Hey @zillemarco! 👋

Thank you for your contribution to the project. Please refer to the contribution rules for a quick overview of the process.

Make sure that this PR clearly explains:

  • the problem being solved
  • the best way a reviewer and you can test your changes

With submitting this PR you confirm that you hold the rights of the code added and agree that it will published under this LICENSE.

The following ChatOps commands are supported:

  • /help: notifies a maintainer to help you out

Simply add a comment with the command in the first line. If you need to pass more information, separate it with a blank line from the command.

This message was generated automatically. You are welcome to improve it.

@zillemarco zillemarco changed the title Added example configuration for Windows-based runners docs: added example configuration for Windows-based runners Mar 20, 2025
@zillemarco
Copy link
Contributor Author

Hi @kayman-mk 👋 Here you can finally find the docs and examples we had talked about in #1233 🙂

Since I extracted the example from our setup, that's still based on the version 8.1.0 of the module but that should still be compatible with the latest version 🤞

@kayman-mk kayman-mk changed the title docs: added example configuration for Windows-based runners docs: add example configuration for Windows-based runners Mar 24, 2025
@kayman-mk
Copy link
Collaborator

What do you think about moving this to a new example in examples/? Would be easier for newcomers and the module call is always checked against the latest version.

Thanks for sharing your configuration.

@zillemarco
Copy link
Contributor Author

What do you think about moving this to a new example in examples/? Would be easier for newcomers and the module call is always checked against the latest version.

Thanks for sharing your configuration.

That's a good idea @kayman-mk, I agree. Only one thing I'd like to check: those examples are not really deployed, right? Because we'd need to create the Windows AMI for that to work otherwise.

If instead those are just checked with, I don't know, terraform plan to make sure the module syntax is correct, then I could just put some placeholder values 🙂

@kayman-mk
Copy link
Collaborator

Placeholders work fine. The examples are never deployed, right.

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