Skip to content
This repository has been archived by the owner on Jan 22, 2024. It is now read-only.

Commit

Permalink
update help and add version info
Browse files Browse the repository at this point in the history
  • Loading branch information
theotherian committed Aug 18, 2020
1 parent a906f93 commit b5c5a44
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 1 deletion.
14 changes: 14 additions & 0 deletions README.md
Expand Up @@ -185,3 +185,17 @@ A test account is provided on creation at `testaccount.json`:
```

The name of the file is used to resolve the PayID - `testaccount.json` will be resolved by `mydomain.tld/testaccount`.

## How do I upgrade?

Releases can be found in the [releases tab](https://github.com/xpring-eng/payid-lambda/releases), with the file `payid-stack.yaml` attached.

The version you have installed will be visible in the description of the stack in CloudFormation (for example, something like `[v1.0] PayID Lambda Server and API Gateway front end`) and also in the `Outputs` of the stack under the name `PayIdLambdaStackVersion`.

To perform an update, click the `Update` button when viewing the stack and upload the version of `payid-stack.yaml` you want to upgrade to.

![update button](./help-images/upgrade/update-button.png)

![update button](./help-images/upgrade/update-form.png)

Note: While this will update the Lambda function it could also update other resources as well in the stack, including API Gateway, S3, etc. We'll outline changes in the release notes if other resources are altered, but be sure to look at the changelog for indications that other resources may be impacted.
Binary file added help-images/upgrade/update-button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help-images/upgrade/update-form.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion payid-stack.yaml
@@ -1,5 +1,5 @@
AWSTemplateFormatVersion: "2010-09-09"
Description: "PayID Lambda Server and API Gateway front end"
Description: "[v1.0] PayID Lambda Server and API Gateway front end"

Parameters:
domainName:
Expand Down Expand Up @@ -479,3 +479,6 @@ Outputs:

nameserver4:
Value: !Select [3, !GetAtt "hostedZone.NameServers"]

PayIdLambdaStackVersion:
Value: "v1.0"

0 comments on commit b5c5a44

Please sign in to comment.