From af37f58f95028163899b1f92395bc7923b495076 Mon Sep 17 00:00:00 2001 From: luismayta Date: Mon, 1 Nov 2021 19:34:29 -0500 Subject: [PATCH] build: generate version (0.12.0) --- CHANGELOG.md | 43 ++++++++ README.md | 162 ++++++++++++++++++++----------- docs/examples/common.md | 24 ++--- internal/version/version.go | 4 +- package.json | 2 +- provision/generators/README.yaml | 2 +- setup.cfg | 2 +- 7 files changed, 167 insertions(+), 72 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b4f0f1a..0f3b1a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,49 @@ All notable changes to this project will be documented in this file. This file uses change log convention from [keep a CHANGELOG](http://keepachangelog.com/en/0.3.0/). + + +## [0.12.0](https://github.com/hadenlabs/terraform-github-repository/compare/0.11.0...0.12.0) + +> 2021-11-01 + +### Bug Fixes + +- load name repository id ([#74](https://github.com/hadenlabs/terraform-github-repository/issues/74)) +- test generate testing faker ([#82](https://github.com/hadenlabs/terraform-github-repository/issues/82)) +- version tag ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) + +### Code Refactoring + +- name template for generator plop ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- configuration project ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- dependencies node ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- generator readme ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- change make actions to task ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) + +### Features + +- implement change visibility with configuration ([#74](https://github.com/hadenlabs/terraform-github-repository/issues/74)) +- change visibility repository ([#74](https://github.com/hadenlabs/terraform-github-repository/issues/74)) +- implement constant visibility repository ([#74](https://github.com/hadenlabs/terraform-github-repository/issues/74)) +- implement module branch protection ([#74](https://github.com/hadenlabs/terraform-github-repository/issues/74)) +- implement configuration branch protection ([#74](https://github.com/hadenlabs/terraform-github-repository/issues/74)) +- implement faker test repository ([#82](https://github.com/hadenlabs/terraform-github-repository/issues/82)) +- implement common and faker repository ([#82](https://github.com/hadenlabs/terraform-github-repository/issues/82)) +- change version terraform ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- implement script test ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- implement configuration log ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- implement return type variable ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- implement configuration sonar ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- implement github actions confluence and sonarqube ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- implement contributing to confluence ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) +- implement lints configuration project ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) + +### Features + +- disabled default project ([#74](https://github.com/hadenlabs/terraform-github-repository/issues/74)) +- implement diagrams with plantuml ([#80](https://github.com/hadenlabs/terraform-github-repository/issues/80)) + ## [0.11.0](https://github.com/hadenlabs/terraform-github-repository/compare/0.10.0...0.11.0) diff --git a/README.md b/README.md index d5e5d82..2e60154 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ - - + + + + -[![Latest Release](https://img.shields.io/github/release/hadenlabs/terraform-github-repository)](https://github.com/hadenlabs/terraform-github-repository/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/terraform-github-repository/lint-code)](https://github.com/hadenlabs/terraform-github-repository/actions?workflow=lint-code) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/Keep%20A%20Changelog-1.0.0-%23E05735)](https://keepachangelog.com) + + [![Latest Release](https://img.shields.io/github/release/hadenlabs/terraform-github-repository)](https://github.com/hadenlabs/terraform-github-repository/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/terraform-github-repository/lint-code)](https://github.com/hadenlabs/terraform-github-repository/actions?workflow=lint-code) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/Keep%20A%20Changelog-1.0.0-%23E05735)](https://keepachangelog.com) # terraform-github-repository -Terraform module to provision an github repository. + + +Terraform module to provision an github repository. + + + + + + + + + + ## Requirements + This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration: - [Pyenv](https://github.com/pyenv/pyenv) @@ -30,13 +46,18 @@ This is a list of plugins that need to be installed previously to enjoy all the - [python](https://www.python.org) - [taskfile](https://github.com/go-task/task) + + + + ## Usage + ```hcl module "main_with_pages" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -65,6 +86,11 @@ This is a list of plugins that need to be installed previously to enjoy all the Full working examples can be found in [examples](./examples) folder. + + + + + ## Examples @@ -80,7 +106,7 @@ Full working examples can be found in [examples](./examples) folder. ```hcl module "main" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -105,7 +131,7 @@ Full working examples can be found in [examples](./examples) folder. module "main_with_key" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -129,7 +155,7 @@ Full working examples can be found in [examples](./examples) folder. module "main_with_secrets" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -151,7 +177,7 @@ Full working examples can be found in [examples](./examples) folder. module "main_with_pages" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -185,7 +211,7 @@ Full working examples can be found in [examples](./examples) folder. module "main" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -215,7 +241,7 @@ Full working examples can be found in [examples](./examples) folder. module "main" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -250,7 +276,7 @@ Full working examples can be found in [examples](./examples) folder. github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -281,7 +307,7 @@ Full working examples can be found in [examples](./examples) folder. github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" is_git_flow = true description = "repository example" @@ -302,7 +328,7 @@ Full working examples can be found in [examples](./examples) folder. github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -321,7 +347,7 @@ Full working examples can be found in [examples](./examples) folder. github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -339,7 +365,7 @@ Full working examples can be found in [examples](./examples) folder. github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -363,7 +389,7 @@ Full working examples can be found in [examples](./examples) folder. github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -378,21 +404,22 @@ Full working examples can be found in [examples](./examples) folder. ``` - + + ## Requirements -| Name | Version | -| ------------------------------------------------------------------------ | ------- | -| [terraform](#requirement_terraform) | >= 0.13 | -| [github](#requirement_github) | >=4.5.0 | -| [local](#requirement_local) | >=1.3.0 | +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.13 | +| [github](#requirement\_github) | >=4.5.0 | +| [local](#requirement\_local) | >=1.3.0 | ## Providers -| Name | Version | -| --------------------------------------------------------- | ------- | -| [github](#provider_github) | >=4.5.0 | +| Name | Version | +|------|---------| +| [github](#provider\_github) | >=4.5.0 | ## Modules @@ -401,7 +428,7 @@ No modules. ## Resources | Name | Type | -| --- | --- | +|------|------| | [github_actions_secret.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/actions_secret) | resource | | [github_branch.develop](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/branch) | resource | | [github_branch.gh_pages](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/branch) | resource | @@ -417,49 +444,55 @@ No modules. ## Inputs | Name | Description | Type | Default | Required | -| --- | --- | --- | --- | :-: | -| [add_labels_default](#input_add_labels_default) | add labels default | `bool` | `true` | no | -| [branch_protection](#input_branch_protection) | branch protections | `map(any)` | `{}` | no | -| [collaborators](#input_collaborators) | List of Collaborator Objects | 
list(object({
 username = string
 permission = string
 }))
| `[]` | no | -| [default_branch](#input_default_branch) | Name of the Default Branch of the Repository | `string` | `"develop"` | no | -| [deploy_keys](#input_deploy_keys) | The name of repositories. | 
list(object({
 title = string
 key = string
 read_only = bool
 }))
| `[]` | no | -| [description](#input_description) | The description of the repository. | `string` | n/a | yes | -| [files](#input_files) | list files for repository | 
list(object({
 branch = string
 file = string
 content = string
 commit_message = string
 commit_author = string
 commit_email = string
 overwrite_on_create = bool
 }))
| `[]` | no | -| [is_git_flow](#input_is_git_flow) | Git Flow - Github Flow | `bool` | `false` | no | -| [name](#input_name) | The name of the repository. | `string` | n/a | yes | -| [pages](#input_pages) | Configuration block for GitHub Pages | `map(any)` | `{}` | no | -| [secrets](#input_secrets) | secrets for repository | `map(any)` | `{}` | no | -| [settings](#input_settings) | Create and manage settings. | `any` | `{}` | no | -| [topics](#input_topics) | topics of project. | `list(string)` | `[]` | no | -| [types](#input_types) | types of project. | `list(string)` | `[]` | no | -| [visibility](#input_visibility) | The visibility of the repository private or public. | `string` | `"private"` | no | +|------|-------------|------|---------|:--------:| +| [add\_labels\_default](#input\_add\_labels\_default) | add labels default | `bool` | `true` | no | +| [branch\_protection](#input\_branch\_protection) | branch protections | `map(any)` | `{}` | no | +| [collaborators](#input\_collaborators) | List of Collaborator Objects | 
list(object({
    username   = string
    permission = string
  }))
| `[]` | no | +| [default\_branch](#input\_default\_branch) | Name of the Default Branch of the Repository | `string` | `"develop"` | no | +| [deploy\_keys](#input\_deploy\_keys) | The name of repositories. | 
list(object({
    title     = string
    key       = string
    read_only = bool
  }))
| `[]` | no | +| [description](#input\_description) | The description of the repository. | `string` | n/a | yes | +| [files](#input\_files) | list files for repository | 
list(object({
    branch              = string
    file                = string
    content             = string
    commit_message      = string
    commit_author       = string
    commit_email        = string
    overwrite_on_create = bool
  }))
| `[]` | no | +| [is\_git\_flow](#input\_is\_git\_flow) | Git Flow - Github Flow | `bool` | `false` | no | +| [name](#input\_name) | The name of the repository. | `string` | n/a | yes | +| [pages](#input\_pages) | Configuration block for GitHub Pages | `map(any)` | `{}` | no | +| [secrets](#input\_secrets) | secrets for repository | `map(any)` | `{}` | no | +| [settings](#input\_settings) | Create and manage settings. | `any` | `{}` | no | +| [topics](#input\_topics) | topics of project. | `list(string)` | `[]` | no | +| [types](#input\_types) | types of project. | `list(string)` | `[]` | no | +| [visibility](#input\_visibility) | The visibility of the repository private or public. | `string` | `"private"` | no | ## Outputs -| Name | Description | -| ----------------------------------------------------------------- | -------------------------------------- | -| [deploy_key](#output_deploy_key) | output instance deploy_key | -| [files](#output_files) | output instance github files | -| [instance](#output_instance) | output instance repository | -| [labels](#output_labels) | output topics github repository | -| [name](#output_name) | output name repository | -| [secrets](#output_secrets) | output instance github actions secrets | -| [topics](#output_topics) | output topics github repository | - +| Name | Description | +|------|-------------| +| [deploy\_key](#output\_deploy\_key) | output instance deploy\_key | +| [files](#output\_files) | output instance github files | +| [instance](#output\_instance) | output instance repository | +| [labels](#output\_labels) | output topics github repository | +| [name](#output\_name) | output name repository | +| [secrets](#output\_secrets) | output instance github actions secrets | +| [topics](#output\_topics) | output topics github repository | + + + + ## Help **Got a question?** File a GitHub [issue](https://github.com/hadenlabs/terraform-github-repository/issues). + ## Contributing ### Bug Reports & Feature Requests + Please use the [issue tracker](https://github.com/hadenlabs/terraform-github-repository/issues) to report any bugs or file feature requests. + ### Development In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. @@ -471,8 +504,11 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. 5. Submit a **Pull Request** so that we can review your changes + + **NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request! + ## Module Versioning This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/). @@ -485,21 +521,37 @@ Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following co ### 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) +- 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-2021 [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-repository + [Your feedback is appreciated](https://github.com/hadenlabs/terraform-github-repository/issues) + diff --git a/docs/examples/common.md b/docs/examples/common.md index 9731bf8..ba9287f 100644 --- a/docs/examples/common.md +++ b/docs/examples/common.md @@ -11,7 +11,7 @@ ```hcl module "main" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -36,7 +36,7 @@ module "main_with_key" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -60,7 +60,7 @@ module "main_with_secrets" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -82,7 +82,7 @@ module "main_with_pages" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -116,7 +116,7 @@ module "main" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -146,7 +146,7 @@ module "main" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github @@ -181,7 +181,7 @@ github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -212,7 +212,7 @@ github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" is_git_flow = true description = "repository example" @@ -233,7 +233,7 @@ github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -252,7 +252,7 @@ github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -270,7 +270,7 @@ github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" @@ -294,7 +294,7 @@ github = github } source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" name = "repository-example" description = "repository example" visibility = "public" diff --git a/internal/version/version.go b/internal/version/version.go index 07daf67..195a578 100644 --- a/internal/version/version.go +++ b/internal/version/version.go @@ -8,7 +8,7 @@ import ( ) // current version -const dev = "0.11.0" +const dev = "0.12.0" // Provisioned by ldflags var ( @@ -22,7 +22,7 @@ func init() { if version == "" { version = dev } - if version == "v0.11.0-" { // building in a directory which is not a git repository + if version == "v0.12.0-" { // building in a directory which is not a git repository version = dev } if commitHash == "" { diff --git a/package.json b/package.json index dfff3ef..62e8322 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@hadenlabs/terraform-github-repository", - "version": "0.11.0", + "version": "0.12.0", "description": "terraform-github-repository for hadenlabs", "author": "Luis Mayta ", "license": "LGPL-3.0", diff --git a/provision/generators/README.yaml b/provision/generators/README.yaml index 8d956b5..c982816 100644 --- a/provision/generators/README.yaml +++ b/provision/generators/README.yaml @@ -70,7 +70,7 @@ usage: |- module "main_with_pages" { source = "hadenlabs/repository/github" - version = "0.11.0" + version = "0.12.0" providers = { github = github diff --git a/setup.cfg b/setup.cfg index a274cee..53d04e6 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,7 +2,7 @@ files = package.json provision/generators/README.yaml internal/version/version.go docs/examples/common.md commit = False tag = False -current_version = 0.11.0 +current_version = 0.12.0 [bumpversion:file:setup.cfg] search = {current_version}