Skip to content

Commit 043316f

Browse files
authored
Cleanup readme text
1 parent 18060b9 commit 043316f

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ When triggered, this workflow:
1313
### Prerequisites
1414

1515
- Create a GitHub Actions workflow file `.github/workflows/release.yml` in your repository.
16-
- Decide how the compliation workflow will be triggered. The recommended way is to configure workflow activation on git tag creation. This should simplify versioning and ensure unique release names.
16+
- Decide how the compilation workflow will be triggered. The recommended way is to configure workflow activation on git tag creation. This should simplify versioning and ensure unique release names.
1717

1818
### Workflow inputs and secrets
1919

2020
Basic compilation workflow path:
2121
`stellar-expert/soroban-build-workflow/.github/workflows/release.yml@main`
2222

2323
The workflow expects the following inputs in the `with` section:
24-
- `release_name` (required) - release name template that includes a release version variable, e.g. `${{ github.ref_name }}`
25-
- `package` (optional) - package name to build. Builds contract in working directory by default
26-
- `relative_path` (optional) - relative path to the contract source directory. Defaults to the repository root directory
27-
- `make_target` (optional) - make target to invoke. Not invoked by default. Useful for contracts with dependencies, that must be built before the main contract
24+
- `release_name` (required) - release name template (should include a release version variable, e.g. `${{ github.ref_name }}`)
25+
- `package` (optional) - package name to build, builds contract in working directory by default
26+
- `relative_path` (optional) - relative path to the contract source directory, defaults to the repository root directory
27+
- `make_target` (optional) - make target to invoke, empty by default (useful for contracts with dependencies that must be built before the main contract)
2828

2929
### Basic workflow for the reporisotry with a single contract
3030

@@ -33,7 +33,7 @@ name: Build and Release # name it whatever you like
3333
on:
3434
push:
3535
tags:
36-
- 'v*' # triggered whenever a new tag (previxed with "v") is pushed to the repository
36+
- 'v*' # triggered whenever a new tag (prefixed with "v") is pushed to the repository
3737
jobs:
3838
release-contract-a:
3939
uses: stellar-expert/soroban-build-workflow/.github/workflows/release.yml@main
@@ -47,6 +47,16 @@ jobs:
4747
release_token: ${{ secrets.GITHUB_TOKEN }} # don't modify this line
4848
```
4949
50+
### Workflow permissions
51+
52+
In order to create a release, the workflow needs `contents: write` permission. Default workflow permissions for a repository can be found at
53+
"Settings"->"Actions"->"Workflow permissions". This workflow should work just fine with default settings ("Read and write permissions").
54+
Alternatively, it's possible to specify permissions in the `.github/workflows/release.yml` configuration file itself:
55+
```yaml
56+
permissions:
57+
contents: write
58+
```
59+
5060
### Building multiple contracts
5161

5262
To build multiple contracts, add a separate job for each contract. The workflow will compile and release each contract independently.

0 commit comments

Comments
 (0)