Skip to content

Commit fc03b9a

Browse files
committed
Update README
1 parent dbf54c9 commit fc03b9a

File tree

1 file changed

+49
-7
lines changed

1 file changed

+49
-7
lines changed

README.md

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ define `bootstrap_packages` to specify what additional packages to install for
2222
the cygport file to be parsable.
2323

2424
```yaml
25-
uses: cygporter/workflows/.github/workflows/ci.yml@main
25+
uses: cygporter/workflows/.github/workflows/build-test.yml@v1
2626
with:
2727
# Required: Path to the cygport file that you want to build and test.
2828
cygport_file: <path>
@@ -32,18 +32,20 @@ with:
3232
bootstrap_packages: <list>
3333
```
3434
35+
The workflow outputs the value of the cygport [`$PV`][PV] variable as `pv`.
36+
3537
### Prepare release
3638

37-
This workflow creates a draft release on GitHub. The release isn't publicly
38-
visible until you manually publish it, and this workflow does not do anything
39-
to push the release to the Cygwin mirrors.
39+
This workflow creates a release on GitHub. By default, the release isn't
40+
publicly visible until you manually publish it, and this workflow does not do
41+
anything to push the release to the Cygwin mirrors.
4042

4143
This workflow expects to find matching build output in the cache, so you will
42-
need to have recently run the `ci.yml` workflow on the same branch and for the
43-
same commit before you can run this one.
44+
need to have recently run the `build-test.yml` workflow on the same branch and
45+
for the same commit before you can run this one.
4446

4547
```yaml
46-
uses: cygporter/workflows/.github/workflows/prep-release.yml@main
48+
uses: cygporter/workflows/.github/workflows/prep-release.yml@v1
4749
with:
4850
# Required: Path to the cygport file that you want to release from.
4951
cygport_file: <path>
@@ -58,9 +60,49 @@ with:
5860
# Optional: Space-separated list of packages required to parse the cygport
5961
# file. Defaults to "cygport".
6062
bootstrap_packages: <list>
63+
64+
# Optional: Whether to publish the release on GitHub. Defaults to "false".
65+
publish: (true|false)
66+
67+
# Needed to be able to create the release.
68+
permissions:
69+
contents: write
70+
```
71+
72+
The workflow outputs the tag that was used for the release as `release_tag`.
73+
This will be the same as the value passed in as `release_tag` if one was passed
74+
in, or `v$PVR` if not.
75+
76+
### Release
77+
78+
This workflow pushes the release to the Cygwin mirrors, and also pushes the
79+
release tag to the Cygwin Git repositories, to aid discoverability.
80+
81+
This workflow expects to be called after the `prep-release.yml` workflow.
82+
83+
```yaml
84+
uses: cygporter/workflows/.github/workflows/release.yml@v1
85+
with:
86+
# Required: Path to the cygport file that you want to release from.
87+
cygport_file: <path>
88+
89+
# Required: Name of the tag used in the GitHub release. This release must be
90+
# published, and will be used to get the correct build to upload to the
91+
# Cygwin mirrors.
92+
tag_name: <tag-name>
93+
94+
# Optional: Space-separated list of packages required to parse the cygport
95+
# file. Defaults to "cygport".
96+
bootstrap_packages: <list>
97+
98+
secrets:
99+
# Required: The RSA private key to connect to the Cygwin servers, as would
100+
# normally be stored at ~/.ssh/id_rsa.
101+
maintainer_key: <string>
61102
```
62103

63104
[reusable workflows]: https://docs.github.com/en/actions/using-workflows/reusing-workflows
64105
[cygport]: https://cygwin.github.io/cygport/
65106
[cygporter/action]: https://github.com/cygporter/action
66107
[actions]: https://docs.github.com/en/actions/creating-actions/about-custom-actions
108+
[PV]: https://cygwin.github.io/cygport/syntax_cygpart.html#PV

0 commit comments

Comments
 (0)