-
Notifications
You must be signed in to change notification settings - Fork 1
/
action.yml
94 lines (83 loc) · 3.08 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
name: Generate Foundry docs
author: Morpho Labs
description: Automatically generates the Foundry docs of your smart contracts, uploading them to an AWS S3 bucket
branding:
icon: info
color: purple
inputs:
aws-s3-bucket:
description: The AWS S3 bucket in which to upload the generated docs book.
required: true
aws-cloudfront-distribution-id:
description: The AWS Cloudfront Distribution ID to invalidate the cache.
required: false
aws-access-key-id:
description: >-
AWS Access Key ID. This input is required if running in the GitHub hosted environment accessible using an IAM user.
It is optional if running in a self-hosted environment that already has AWS credentials,
for example on an EC2 instance.
required: false
aws-secret-access-key:
description: >-
AWS Secret Access Key. This input is required if running in the GitHub hosted environment accessible using an IAM user.
It is optional if running in a self-hosted environment that already has AWS credentials,
for example on an EC2 instance.
required: false
role-to-assume:
description: >-
AWS Role to assume. This input is required if running in the GitHub hosted environment with role based authentication.
It is optional if running in a self-hosted environment that already has AWS credentials,
for example on an EC2 instance.
required: false
role-session-name:
description: "AWS Role Session Name"
required: false
aws-session-token:
description: "AWS Session Token"
required: false
aws-region:
description: "AWS Region, e.g. us-east-2"
required: true
s3-acl:
description: "S3 ACL, e.g. public-read or private"
required: false
default: private
runs:
using: composite
steps:
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 16
cache: yarn
- name: Install Foundry
uses: onbjerg/foundry-toolchain@v1
with:
version: nightly
- name: Install node dependencies
run: yarn install --frozen-lockfile
shell: bash
- name: Generate docs
run: forge doc --build
shell: bash
- name: Upload docs
uses: actions/upload-artifact@v3
with:
name: forge-docs
path: docs/book/
- name: Setup AWS credentials
uses: aws-actions/configure-aws-credentials@v2
with:
aws-access-key-id: ${{ inputs.aws-access-key-id }}
aws-secret-access-key: ${{ inputs.aws-secret-access-key }}
role-to-assume: ${{ inputs.role-to-assume }}
role-session-name: ${{ inputs.role-session-name }}
aws-session-token: ${{ inputs.aws-session-token }}
aws-region: ${{ inputs.aws-region }}
- name: Upload docs to S3
run: aws s3 sync docs/book/ s3://${{ inputs.aws-s3-bucket }} --delete --acl ${{ inputs.s3-acl }}
shell: bash
- name: Invalidate CloudFront cache
if: ${{ inputs.aws-cloudfront-distribution-id != '' }}
run: aws cloudfront create-invalidation --distribution-id ${{ inputs.aws-cloudfront-distribution-id }} --paths "/*"
shell: bash