Skip to content

Commit 12206cd

Browse files
authored
docs: small readme update (#1446)
1 parent 78642e9 commit 12206cd

2 files changed

Lines changed: 10 additions & 37 deletions

File tree

README.md

Lines changed: 9 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -26,50 +26,21 @@ the `uses` field of a Job step
2626
### Action Versions
2727

2828
This is a monorepo and all actions are versioned and tagged with the format
29-
`<action>@<version>`. To find the available versions, and corresponding commit
30-
for an action:
29+
`<action>/vX.Y.Z` or w/ mutable major version tags `<action>/vX`. To find the
30+
available versions, and corresponding commit for an action:
3131

3232
- Look at the repo's tags through Github UI:
3333
https://github.com/smartcontractkit/.github/tags
34-
- Query the tags through CLI
35-
```
34+
- Query the tags through CLI (faster)
35+
```sh
3636
git for-each-ref --format="%(objectname) %(refname:short)" refs/tags | grep "<action name>"
3737
```
3838

3939
### Automated Updates
4040

41-
Updating these actions automatically requires a custom workflow, as Dependabot
42-
doesn't support updates for actions contained in monorepos.
43-
44-
<details>
45-
<summary>Example Workflow</summary>
46-
47-
```
48-
name: Update Actions
49-
50-
on:
51-
schedule:
52-
- cron: "0 0 * * *"
53-
54-
jobs:
55-
update-actions:
56-
runs-on: ubuntu-latest
57-
permissions:
58-
id-token: write
59-
contents: write
60-
pull-requests: write
61-
steps:
62-
- name: Update custom actions
63-
uses: smartcontractkit/.github/actions/update-actions@5f5ebd52cb13f4b8530cd3005ec7ec3180840219 # update-actions@0.1.5
64-
with:
65-
aws-role-arn: ${{ secrets.AWS_OIDC_IAM_ROLE_ARN_GATI }}
66-
aws-lambda-url: ${{ secrets.AWS_LAMBDA_URL_GATI }}
67-
aws-role-arn-updater: ${{ secrets.AWS_OIDC_IAM_ROLE_ARN_GATI_UPDATER }}
68-
aws-lambda-url-updater: ${{ secrets.AWS_LAMBDA_URL_GATI_UPDATER }}
69-
aws-region: ${{ secrets.AWS_REGION }}
70-
```
71-
72-
</details>
41+
We recommend using the major version tags for actions stored within this
42+
repository. This ensures that all actions are automatically updated if new minor
43+
or patch versions are released for the major version you are pinned to.
7344

7445
## Contributing
7546

@@ -113,6 +84,8 @@ follows:
11384

11485
1. You merge a change with a changeset file (in the `.changeset` directory)
11586
1. Created through invoking `pnpm changeset`
87+
2. Or through [`gocs`](https://github.com/smartcontractkit/gocs)
88+
(`go install github.com/smartcontractkit/gocs/cmd/gocs@latest`)
11689
2. A "Version packages" pull request will open or update
11790
([ex](https://github.com/smartcontractkit/.github/pull/540)). This PR will
11891
"consume" the changesets present in the default branch by:

actions/ci-lint-go/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
actions: read
1717
steps:
1818
- name: golangci-lint
19-
uses: smartcontractkit/.github/actions/ci-lint-go@5f5ebd52cb13f4b8530cd3005ec7ec3180840219 # v0.2.5
19+
uses: smartcontractkit/.github/actions/ci-lint-go@ci-lint-go/v4
2020
with:
2121
go-version-file: go.mod
2222
```

0 commit comments

Comments
 (0)