-
Notifications
You must be signed in to change notification settings - Fork 629
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8ebf0fb
Showing
11 changed files
with
186 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# state | ||
*.tfstate* | ||
|
||
# Module directory | ||
.terraform/ | ||
|
||
# keys | ||
*id_rsa* | ||
|
||
# other | ||
.idea | ||
.DS_Store | ||
*.out | ||
example/*.secrets*.tfvars | ||
.envrc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
# Contributing to Forest Terraform | ||
|
||
We'd love for you to contribute to our source code and to make the Forest even better than it is today! Here are the guidelines we'd like you to follow: | ||
|
||
- [Question or Problem?](#question) | ||
- [Issues and Bugs](#issue) | ||
- [Feature Requests](#feature) | ||
- [Submission Guidelines](#submit) | ||
- [Further Info](#info) | ||
|
||
## <a name="question"></a> Got a Question or Problem? | ||
|
||
If you have questions about how to use the Forest, please direct these to the [Slack group / philips-software][slack]. | ||
|
||
[![Slack](https://philips-software-slackin.now.sh/badge.svg)](https://philips-software-slackin.now.sh) | ||
|
||
## <a name="issue"></a> Found an Issue? | ||
|
||
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our [Github Repository][github]. Even better you can submit a Pull Request with a fix. | ||
|
||
**Please see the [Submission Guidelines](#submit) below.** | ||
|
||
## <a name="feature"></a> Want a Feature? | ||
|
||
You can request a new feature by submitting an issue to our [Github Repository][github]. If you would like to implement a new feature then consider what kind of change it is: | ||
|
||
* **Major Changes** that you wish to contribute to the project should be discussed first on our [Slack group][slack] so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. | ||
* **Small Changes** can be crafted and submitted to the [Github Repository][github] as a Pull Request. | ||
|
||
|
||
## <a name="docs"></a> Want a Doc Fix? | ||
|
||
If you want to help improve the docs, it's a good idea to let others know what you're working on to minimize duplication of effort. Create a new issue (or comment on a related existing one) to let others know what you're working on. | ||
|
||
For large fixes, please build and test the documentation before submitting the MR to be sure you haven't accidentally introduced any layout or formatting issues. You should also make sure that your commit message starts with "docs" and follows the **[Commit Message Guidelines](#commit)** outlined below. | ||
|
||
## <a name="submit"></a> Submission Guidelines | ||
|
||
### Submitting an Issue | ||
Before you submit your issue search the archive, maybe your question was already answered. | ||
|
||
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly: | ||
|
||
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps | ||
* **Motivation for or Use Case** - explain why this is a bug for you | ||
* **Forest Version(s)** - is it a regression? | ||
* **Reproduce the Error** - try to describe how to reproduce the error | ||
* **Related Issues** - has a similar issue been reported before? | ||
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be | ||
causing the problem (line of code or commit) | ||
|
||
**If you get help, help others. Good karma rulez!** | ||
|
||
### Submitting a Merge Request | ||
Before you submit your merge request consider the following guidelines: | ||
|
||
* Make your changes in a new git branch: | ||
|
||
```shell | ||
git checkout -b my-fix-branch master | ||
``` | ||
|
||
* Create your patch, **including appropriate test cases**. | ||
* Run the test suite and ensure that all tests pass. | ||
* Add a line in the CHANGELOG.md under Unreleased. This will be used form generating the release notes. | ||
* Commit your changes using a descriptive commit message. | ||
|
||
```shell | ||
git commit -a | ||
``` | ||
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. | ||
|
||
* Build your changes locally to ensure all the tests pass: | ||
* Push your branch to Github: | ||
|
||
```shell | ||
git push origin my-fix-branch | ||
``` | ||
|
||
In Github, send a pull request to original master branch: f.e. `terraform-aws-vpc:master`. | ||
If we suggest changes, then: | ||
|
||
* Make the required updates. | ||
* Re-run the test suite to ensure tests are still passing. | ||
* Commit your changes to your branch (e.g. `my-fix-branch`). | ||
* Push the changes to your Github repository (this will update your Pull Request). | ||
|
||
If the PR gets too outdated we may ask you to rebase and force push to update the PR: | ||
|
||
```shell | ||
git rebase master -i | ||
git push origin my-fix-branch -f | ||
``` | ||
|
||
_WARNING: Squashing or reverting commits and force-pushing thereafter may remove Github comments on code that were previously made by you or others in your commits. Avoid any form of rebasing unless necessary._ | ||
|
||
That's it! Thank you for your contribution! | ||
#### After your merge request is merged | ||
After your pull request is merged, you can safely delete your branch and pull the changes | ||
from the main (upstream) repository: | ||
* Delete the remote branch on Github either through the Github web UI or your local shell as follows: | ||
```shell | ||
git push origin --delete my-fix-branch | ||
``` | ||
* Check out the master branch: | ||
```shell | ||
git checkout master -f | ||
``` | ||
* Delete the local branch: | ||
```shell | ||
git branch -D my-fix-branch | ||
``` | ||
* Update your master with the latest upstream version: | ||
```shell | ||
git pull --ff upstream master | ||
``` | ||
## <a name="info"></a> Info | ||
For more info, please reach out to the team on [Slack group / philips-software][slack] in the #forest channel. | ||
Use the badge to sign-up. | ||
[![Slack](https://philips-software-slackin.now.sh/badge.svg)](https://philips-software-slackin.now.sh) | ||
[contribute]: CONTRIBUTING.md | ||
[github]: https://github.com/philips-lam/terraform-aws-github-runner/issues | ||
[slack]: https://philips-software.slack.com/home |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
The MIT License (MIT) Copyright © 2020 Koninklijke Philips N.V, https://www.philips.com | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Gertjan Maas <[email protected]> | ||
Niek Palm <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Terraform module for scalable self hosted GitHub action runners | ||
|
||
> WIP: Module is in development | ||
|
||
|
||
|
||
## Philips Forest | ||
|
||
This module is part of the Philips Forest. | ||
|
||
``` | ||
___ _ | ||
/ __\__ _ __ ___ ___| |_ | ||
/ _\/ _ \| '__/ _ \/ __| __| | ||
/ / | (_) | | | __/\__ \ |_ | ||
\/ \___/|_| \___||___/\__| | ||
Infrastructure | ||
``` | ||
|
||
Talk to the forestkeepers in the `forest`-channel on Slack. | ||
|
||
[![Slack](https://philips-software-slackin.now.sh/badge.svg)](https://philips-software-slackin.now.sh) |
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.