An open API service indexing awesome lists of open source software.

https://github.com/hadenlabs/terraform-github-project

github project for terraform
https://github.com/hadenlabs/terraform-github-project

github hadenlabs peru project terraform terraform-modules

Last synced: 3 months ago
JSON representation

github project for terraform

Awesome Lists containing this project

README

        

[![Build Status](https://travis-ci.org/hadenlabs/terraform-github-project.svg?branch=main)](https://travis-ci.org/hadenlabs/terraform-github-project) [![Latest Release](https://img.shields.io/github/release/hadenlabs/terraform-github-project.svg)](https://travis-ci.org/hadenlabs/terraform-github-project/releases)

# terraform-github-project

Terraform module to provision an github project.

## Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

- [gomplate](https://github.com/hairyhenderson/gomplate)
- [terraform](https://github.com/hashicorp/terraform)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)

## Usage

# How to use this project

usage: |-

```hcl
module "main" {
source = "hadenlabs/project/github"
version = "0.4.0"

providers = {
github = github
}

name = "terraform-github-project"
body = "project terraform github project."
}
```

Full working example can be found in [example](/example) folder.

## Examples

### Common

## Requirements

| Name | Version |
| --------- | ------- |
| terraform | >= 0.13 |
| github | >=4.3.0 |

## Providers

| Name | Version |
| ------ | ------- |
| github | >=4.3.0 |

## Modules

No modules.

## Resources

| Name | Type |
| --- | --- |
| [github_organization_project.project](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_project) | resource |
| [github_project_column.project_backlog_column](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/project_column) | resource |

## Inputs

| Name | Description | Type | Default | Required |
| --- | --- | --- | --- | :-: |
| body | body of project. | `string` | `""` | no |
| columns | (Optional) The names of the columns. | `list(string)` |

[
"Backlog",
"To Do",
"Do Today",
"In Progress",
"In Review",
"Approved",
"Done"
]
| no |
| name | The name of the project. | `string` | n/a | yes |

## Outputs

| Name | Description |
| ------- | --------------------------- |
| project | output project name and url |

## Help

**Got a question?**

File a GitHub [issue](https://github.com/hadenlabs/terraform-github-project/issues).

## Contributing

See [Contributing](./docs/contributing.md).

## Module Versioning

This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).

Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:

1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)

## Copyright

Copyright © 2018-2024 [Hadenlabs](https://hadenlabs.com)

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## License

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like terraform-github-project

[Your feedback is appreciated](https://github.com/hadenlabs/terraform-github-project/issues)