Skip to content

Commit

Permalink
recreate docs with mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
schlapzz committed Jun 30, 2023
1 parent 8ba4e87 commit cb879ec
Show file tree
Hide file tree
Showing 15 changed files with 298 additions and 257 deletions.
41 changes: 2 additions & 39 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,6 @@ goff diff "/tmp/source" "/tmp/target" --title=Preview --output-dir .

### ArgoCD Application

Example for ArgoCD Application diff
```bash
#Render all ArgoCD manifests in directory from source branch
goff argocd app "./source/argocd" --repo-server="repo-server:8081" --output-dir=/tmp/source/
#Render all ArgoCD manifests in directory from target branch
goff argocd app "./target/argocd" --repo-server="repo-server:8081" --output-dir=/tmp/target/
#Diff rendered Kubernetes manifests
goff diff "/tmp/source" "/tmp/target" --output-dir .
```

1. Create a new branch and commit your changes in your ArgoCd Application
![GitHub Diff](doc/img/github-argo-diff.png)
2. Run your pipeline, Goff renders the Appication into manifests calculate the diff between the source and target branch.
3. Check the auto generated comment in your Pull request and review the changes
![GitHub Diff](doc/img/goff-argo-diff.png)

## Usage

```bash
Expand Down Expand Up @@ -77,27 +61,6 @@ Use "goff [command] --help" for more information about a command.
| ArgoCD Application | ✅ Needs a local ArgoCD Repo server instance |
| ArgoCD ApplicationSet | 🚧 Not yet fully supported (List generators only) |

## Build

### Build binary from source

```bash
go build -o goff goff
```

### Build Image with dagger

```bash
export REGISTRY_PASSWORD=....
export REGISTRY_USER=....
go run ci/main.go
```

If you wanna try the new fancy Dagger TUI
## Documentation

```bash
export _EXPERIMENTAL_DAGGER_TUI=1
export REGISTRY_PASSWORD=....
export REGISTRY_USER=....
dagger run go run ci/main.go
```
here
48 changes: 0 additions & 48 deletions doc/github/argocd.yml

This file was deleted.

38 changes: 0 additions & 38 deletions doc/github/helm.yml

This file was deleted.

38 changes: 0 additions & 38 deletions doc/github/kustomize.yml

This file was deleted.

65 changes: 0 additions & 65 deletions doc/gitlab/.gitlab-ci.yml

This file was deleted.

29 changes: 0 additions & 29 deletions doc/integrations.md

This file was deleted.

20 changes: 20 additions & 0 deletions docs/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Build

### Build binary from source

```bash
go build -o goff goff
```

### Build Image with dagger

```bash
go run ci/main.go
```

or

```bash
dagger run go run ci/main.go
```

Loading

0 comments on commit cb879ec

Please sign in to comment.