https://github.com/iac-factory/fargate-runner
AWS Serverless Fargate + GitLab Runner
https://github.com/iac-factory/fargate-runner
Last synced: 2 months ago
JSON representation
AWS Serverless Fargate + GitLab Runner
- Host: GitHub
- URL: https://github.com/iac-factory/fargate-runner
- Owner: iac-factory
- License: bsd-3-clause
- Created: 2022-07-04T05:33:04.000Z (almost 3 years ago)
- Default Branch: Development
- Last Pushed: 2022-07-04T19:47:12.000Z (almost 3 years ago)
- Last Synced: 2025-02-08T17:44:56.556Z (4 months ago)
- Language: HCL
- Size: 128 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AWS Fargate + GitLab Runner #
## Resources
## Examples
```hcl
provider "aws" {}
```
#### Providers
No providers.
#### Inputs
No inputs.
## Documentation ##
Documentation is both programmatically and conventionally generated.
**Note** - Given the workflow between `git` & `pre-commit`, when creating
a new commit, ensure to run the following:
```bash
git commit -a --message "..."
```
If a commit shows as a **Failure**, ***such is the job of the pre-commit hook***.
Simply re-commit and then the repository should be able to be pushed to.
### Generating `tfvars` & `tfvars.json` ###
```bash
terraform-docs tfvars hcl "$(git rev-parse --show-toplevel)"
terraform-docs tfvars json "$(git rev-parse --show-toplevel)"
```
### `terraform-docs` ###
In order to install `terraform-docs`, ensure `brew` is installed (for MacOS systems), and run
```bash
brew install terraform-docs
```
If looking to upgrade:
```bash
brew uninstall terraform-docs
brew install terraform-docs
```
It's elected to use `brew uninstall` vs `brew upgrade` because old versions are then removed.
### `git` & `pre-commit` ###
Documentation is often a second thought; refer to the following steps to ensure documentation is always updated
upon `git commit`.
1. Install Pre-Commit
```bash
brew install pre-commit || pip install pre-commit
```
2. Check Installation + Version
```bash
pre-commit --version
```
3. Generate Configuration (`.pre-commit-config.yaml`)
4. Configure `git` hooks
```bash
pre-commit install
pre-commit install-hooks
```
- If any errors show:
```bash
git config --unset-all core.hooksPath
```
**Most Importantly**
> *`pre-commit install` should always be the first command after a project is cloned.*