Skip to content

Commit

Permalink
feat: Added support for modules being able to supply a default value …
Browse files Browse the repository at this point in the history
…for a parameter when the condition is not met. Also improved documentation. (#420)

* feat: Added support for modules being able to supply a default value for a parameter when the condition is not met. 
Also improved documentation.

* Bumped go version in github action
  • Loading branch information
bmonkman authored Oct 6, 2021
1 parent a05fe27 commit 65d4147
Show file tree
Hide file tree
Showing 18 changed files with 253 additions and 503 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ orbs:

variables:
- &workspace /home/circleci/project
- &build-image circleci/golang:1.13.8
- &build-image circleci/golang:1.16.8

aliases:
# Shallow Clone - this allows us to cut the 2 minute repo clone down to about 10 seconds for repos with 50,000 commits+
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: 1.12
go-version: 1.16
- uses: actions/cache@v2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Run Go Tests
- name: Run Go Tests
run: |
make check
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Slack](https://img.shields.io/badge/slack-join-brightgreen?logo=slack&style=social)](https://slack.getzero.dev)

<p align="center" width="100%">
<img width="66%" src="https://raw.githubusercontent.com/commitdev/zero/main/docs/img/logo.png">
<img width="66%" src="https://raw.githubusercontent.com/commitdev/zero/main/docs-site/logo.png">
</p>

## What is Zero
Expand All @@ -23,7 +23,7 @@ Everything built by Zero is yours. After using Zero to generate your infrastruct

It's easy to get started, the only thing you'll need is an AWS account. Just enter your AWS CLI tokens or choose your existing profile during the setup process and everything is built for you automatically using infrastructure-as-code so you can see exactly what's happening and easily modify it if necessary.

[Read about the day-to-day experience of using a system set up using Zero](docs/real-world-usage.md)
[Read about the day-to-day experience of using a system set up using Zero](https://getzero.dev/docs/zero/about/real-world-usage)


## Why is Zero Reliable, Scalable, Performant, and Secure
Expand All @@ -36,9 +36,9 @@ Security: Properly configured access-control to resources/security groups, using


## What do you get out of the box?
[Read about why we made these technology choices and where they are most applicable.](docs/technology-choices.md)
[Read about why we made these technology choices and where they are most applicable.](https://getzero.dev/docs/zero/about/technology-choices)

[Check out some resources for learning more about these technologies.](docs/learning-resources.md)
[Check out some resources for learning more about these technologies.](https://getzero.dev/docs/zero/reference/learning-resources)

### Infrastructure
- Fully configured infrastructure-as-code AWS environment including:
Expand Down Expand Up @@ -78,12 +78,12 @@ ___
### Project Definition:
Each project is defined by this project definition file, this manifest contains your project details, and is the source of truth for the templating(`zero create`) and provision(`zero apply`) steps.

See [`zero-project.yml` reference](./docs/project-definition.md) for details.
See [`zero-project.yml` reference](https://getzero.dev/docs/zero/reference/project-definition) for details.
### Module Definition
Module definition defines the information needed for the module to run (`zero apply`).
Also declares dependency used to determine the order of execution with other modules.

See [`zero-module.yml` reference](./docs/module-definition.md) for details.
See [`zero-module.yml` reference](https://getzero.dev/docs/zero/reference/module-definition) for details.
___


Expand Down
12 changes: 7 additions & 5 deletions cmd/zero.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package cmd

import (
"fmt"
"os"

"github.com/spf13/cobra"
Expand All @@ -10,14 +9,17 @@ import (
var rootCmd = &cobra.Command{
Use: "zero",
Short: "zero gets you to writing code quicker.",
Long: "Zero is an open-source developer platform CLI tool which makes it quick and easy for technical founders & developers \nto build quality and reliable infrastructure to launch, grow and scale high-quality SaaS applications faster and more cost-effectively.",
Long: "Zero is an open-source CLI tool which makes it quick and easy for technical founders & developers \nto build high-quality, reliable infrastructure to launch, grow, and scale production-ready SaaS applications faster and more cost-effectively.\n https://getzero.dev\n",
Run: func(cmd *cobra.Command, args []string) {
},
}

func Execute() {
if err := rootCmd.Execute(); err != nil {
fmt.Println(err)
os.Exit(1)
if len(os.Args) > 1 {
if err := rootCmd.Execute(); err != nil {
os.Exit(1)
}
} else { // If no arguments were provided, print the usage message.
rootCmd.Help()
}
}
155 changes: 81 additions & 74 deletions doc-site/docs/reference/module-definition.md

Large diffs are not rendered by default.

File renamed without changes
Binary file removed docs/img/zero-check.png
Binary file not shown.
26 changes: 0 additions & 26 deletions docs/learning-resources.md

This file was deleted.

90 changes: 0 additions & 90 deletions docs/module-definition.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/project-definition.md

This file was deleted.

Loading

0 comments on commit 65d4147

Please sign in to comment.