Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
malachi-constant committed Aug 13, 2024
1 parent 3248bea commit 4ed8816
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/source/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,20 @@ To upgrade:
```

`seed-farmer` 5.0.0 also introduces the use of `npmMirrorSecret` to support configuring a npm mirror with credentials (see [Manifests - Mirrors](./manifests.md#mirroroverride)).

**The following upgrade is optional**
Seedkits must be upgraded if **both** of the following is true.
- Both `npmMirrorSecret` & `pypiMirrorSecret` are set.
- Mirror secrets are using explicit paths. I.e. (`my-mirror-credentials::npm` && `my-mirror-credentials::pypi`).

**Note: You can still use this feature by specifying your secret name `my-mirror-credentials` without a path `::pypi` for both secrets.

To upgrade:
1. Update your version of `aws-codeseeder` via
```bash
pip install --upgrade codeseeder==1.1.0
```
2. Run seedfarmer with the `--update-seedkit` flag set
```bash
seedfarmer apply my/manifest/path --update-seedkit
```

0 comments on commit 4ed8816

Please sign in to comment.