Skip to content

Commit fd5eef1

Browse files
authored
docs: Switch to attribution of Mineiros (#15)
1 parent 353fcdf commit fd5eef1

File tree

17 files changed

+78
-3114
lines changed

17 files changed

+78
-3114
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @gaima8

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ repos:
77
- id: end-of-file-fixer
88
- id: mixed-line-ending
99
- repo: https://github.com/antonbabenko/pre-commit-terraform
10-
rev: v1.89.0
10+
rev: v1.104.0
1111
hooks:
1212
- id: terraform_fmt
1313
- id: terraform_tflint

.terraform-docs.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
formatter: "markdown document"
2+
settings:
3+
hide-empty: true
4+
lockfile: false
5+
indent: 3

CHANGELOG.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [0.19.2]
9+
10+
### Features
11+
12+
* Various updates ([#7](https://github.com/gaima8/terraform-github-repository/issues/7)) ([035f478](https://github.com/gaima8/terraform-github-repository/commit/035f4788abc91fbc0a81d3cb6bb7480fb1d137d1))
913

1014
## [0.19.1]
1115

@@ -419,7 +423,8 @@ Please review plans and report regressions and issues asap so we can improve doc
419423
- This is the initial release of our GitHub Repository module with support for
420424
creating and managing GitHub Repositories for Organizations.
421425

422-
[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.19.0...HEAD
426+
[0.19.2]: https://github.com/gaima8/terraform-github-repository/compare/v0.19.1...v0.19.2
427+
[0.19.1]: https://github.com/gaima8/terraform-github-repository/compare/v0.19.0...v0.19.1
423428
[0.19.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.18.0...v0.19.0
424429
[0.18.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.17.0...v0.18.0
425430
[0.17.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.16.2...v0.17.0

CONTRIBUTING.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ First and foremost, we’d like to express our gratitude to you for taking the t
44
We welcome and appreciate any and all contributions via
55
[Pull Requests] along the [GitHub Flow].
66

7-
1. [Open a GitHub issue](#open-a-github-issue)
8-
2. [Fork the repository on GitHub](#fork-the-repository-on-github)
9-
3. [Install the pre-commit hooks](#install-the-pre-commit-hooks)
10-
4. [Update the documentation](#update-the-documentation)
11-
5. [Update the tests](#update-the-tests)
12-
6. [Update the code](#update-the-code)
13-
7. [Create a pull request](#create-a-pull-request)
14-
8. [Merge and release](#merge-and-release)
7+
- [Contribution Guidelines](#contribution-guidelines)
8+
- [Open a GitHub issue](#open-a-github-issue)
9+
- [Fork the repository on GitHub](#fork-the-repository-on-github)
10+
- [Install the pre-commit hooks](#install-the-pre-commit-hooks)
11+
- [Update the documentation](#update-the-documentation)
12+
- [Update the code](#update-the-code)
13+
- [Create a pull request](#create-a-pull-request)
14+
- [Merge and release](#merge-and-release)
15+
- [Releases](#releases)
1516

1617
## Open a GitHub issue
1718

@@ -42,18 +43,6 @@ We encourage you to update the documentation before writing any code (please see
4243
documentation stays up to date and allows you to think through the problem fully before you begin implementing any
4344
changes.
4445

45-
## Update the tests
46-
47-
We also recommend updating the automated tests before updating any code
48-
(see [Test Driven Development](https://en.wikipedia.org/wiki/Test-driven_development)).
49-
50-
That means that you should add or update a test case, run all tests and verify
51-
that the new test fails with a clear error message and then start implementing
52-
the code changes to get that test to pass.
53-
54-
The test folder in every repository will have documentation on how to run the
55-
tests locally.
56-
5746
## Update the code
5847

5948
At this point, make your code changes and constantly test again your new test case to make sure that everything working
@@ -73,12 +62,16 @@ Please make sure to include the following:
7362
## Merge and release
7463

7564
The [CODEOWNERS] of the repository will review your code and provide feedback.
76-
If everything looks good, they will merge the code and release a new version while following the principles of [Semantic Versioning (SemVer)].
65+
If everything looks good, they will merge the code and potentially release a new version while following the principles of [Semantic Versioning (SemVer)].
66+
67+
### Releases
68+
69+
Release Please will create and update a pull request, which updates the CHANGELOG and prepares for a release. A [CODEOWNERS] will merge this at their discretion to action a release.
7770

7871
<!-- References -->
7972

80-
[pull requests]: https://github.com/mineiros-io/terraform-github-repository/pulls
81-
[pre-commit-file]: https://github.com/mineiros-io/terraform-github-repository/blob/main/.pre-commit-config.yaml
73+
[pull requests]: https://github.com/gaima8/terraform-github-repository/pulls
74+
[pre-commit-file]: https://github.com/gaima8/terraform-github-repository/blob/main/.pre-commit-config.yaml
8275
[github flow]: https://guides.github.com/introduction/flow/
8376
[codeowners]: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
8477
[fork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo

Makefile

Lines changed: 0 additions & 163 deletions
This file was deleted.

0 commit comments

Comments
 (0)