Skip to content

Commit 827244d

Browse files
authored
Update DEV instructions (#460)
* run install again * WG357 Kubeconfig name * Update dev and release instructions * Update workflow
1 parent 2299a67 commit 827244d

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

docs/developing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ make binaries
1919
If you encounter a build error for the containers which looks like this:
2020

2121
```log
22-
> [builder 7/15] RUN go mod download:
22+
> [builder 7/15] RUN go mod download:
2323
#15 20.58 go mod download: github.com/weaveworks/[email protected]: invalid version: git ls-remote -q origin in /go/pkg/mod/cache/vcs/2d85ed3446e0807d78000711febc8f5eeb93fa1a010e290025afb84defca1ae6: exit status 128:
2424
#15 20.58 remote: Invalid username or password.
2525
#15 20.58 fatal: Authentication failed for 'https://github.com/weaveworks/weave-gitops-enterprise-credentials/'
@@ -96,7 +96,7 @@ Run the server:
9696
export KUBECONFIG=test-server-kubeconfig
9797

9898
# The weave-gitops core library uses an embedded Flux. That's not going to work when used as a library though
99-
# so we need to tell it to use a different Flux. This is also done by the cluster-service deployment.
99+
# so we need to tell it to use a different Flux. This is also done by the cluster-service deployment.
100100
WEAVE_GITOPS_FLUX_BIN_PATH=`which flux`
101101

102102
# Run the server configured using lots of env vars
@@ -226,7 +226,7 @@ The private ssh key to the server lives in the `pesto test cluster ssh key` secr
226226

227227
2. Update the deployed version on the test cluster
228228

229-
1. As of writing the `HelmRelease` lives in [management/weave-gitops-enterprise/artifacts/mccp-chart/helm-chart/HelmRelease.yaml](https://github.com/wkp-example-org/capd-demo-simon/blob/main/management/weave-gitops-enterprise/artifacts/mccp-chart/helm-chart/HelmRelease.yaml), but may have moved, so look around for the helm-release file if this has gone missing.
229+
1. As of writing the `HelmRelease` lives in [.weave-gitops/clusters/kind-kind/system/weave-gitops-enterprise.yaml](https://github.com/wkp-example-org/capd-demo-simon/blob/main/.weave-gitops/clusters/kind-kind/system/weave-gitops-enterprise.yaml), but may have moved, so look around for the helm-release file if this has gone missing.
230230
2. Find the `spec.chart.spec.version` field and change it to the desired value.
231231
3. If this is an official release (`0.0.9` etc) make sure the release repo is set:
232232
```

docs/releasing.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
How to release a new version of weave-gitops-enterprise
66

7+
## Prerequisites
8+
9+
Install [GnuPG](https://gnupg.org/) and [generate a GPG key and add it to your Github account](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key).
10+
11+
If you aren't using the GPG suite, you will need to [add the GPG key to your .bashrc / .zshrc](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key).
12+
713
## Create a tag
814

915
_This may be possible by creating a tag via the releases system in the github UI, please test and update here._
@@ -16,11 +22,3 @@ git push origin v0.0.6
1622
```
1723

1824
CircleCI will build the new release based on the new tag.
19-
20-
## Create a release in GitHub
21-
22-
- Go to the **Releases page** for the weave-gitops repository
23-
- Click on **Draft a New Release**
24-
- Add the tag you just pushed
25-
- Add some release notes. It would be nice to automate this in the future. Its probably easiest to copy the last release as a template and then modify the list of _fixes_ and _new features_.
26-
- Click on **Publish Release**

0 commit comments

Comments
 (0)