Skip to content

Commit 4f24ffd

Browse files
authored
Update README.md
1 parent 2008a9e commit 4f24ffd

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ to your project or organization:
2828
- `GIT_AUTHOR_EMAIL` - email address of the author of your releases: can be an email address of a bot account.
2929
- `SIGNING_SECRET_KEY` - a **password-less** private GPG key in ASCII format, to be used for signing your releases:
3030
please use a dedicated GPG subkey for this purpose. Unsigned releases are not supported, and won't be supported.
31+
To generate a new GPG key use the following commands
32+
`gpg2 --full-generate-key` Pick option 4, then type 4096 for key size, select your desired expiry. Fill out the user information and leave the password blank.
33+
Once generated it will output something like `gpg: key <Key ID> marked as ultimately trusted` take a note of this Key Id to use in the next step
34+
`gpg --output private.key --armor --export-secret-key <Key ID>` This will output the key to the file private.key in the correct format to paste into github. Delete the file once you are done and don't share it with anyone else
35+
Optionally you can use `gpg --output public.key --armor --export <Key ID>` to export the corresponding public key. You can publish this key on your project webpage to allow users to verify your signed releases.
3136
- `ORGANIZATION_ADMIN_TOKEN` - if you use the file from [`examples/.github/workflows/release-on-milestone-closed.yml`](examples/.github/workflows/release-on-milestone-closed.yml),
3237
then you have to provide a `ORGANIZATION_ADMIN_TOKEN` (with a full repo scope), which is a github token with
3338
administrative rights over your organization (issued by a user that has administrative rights over your project).
@@ -40,6 +45,12 @@ you when you enable GitHub Actions. To learn more about how it works, read
4045
["Authenticating with the GITHUB\_TOKEN"](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
4146
in the GitHub Docs.
4247

48+
### Branches
49+
50+
You will also need to setup the initial branches used by this project.
51+
52+
@TODO
53+
4354
## Usage
4455

4556
Assuming your project has Github Actions enabled, each time you [**close**](https://developer.github.com/webhooks/event-payloads/#milestone)

0 commit comments

Comments
 (0)