Skip to content

Commit de2a418

Browse files
committed
Document how the release process works
1 parent 43193a8 commit de2a418

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ EQL provides a data format for transmitting and storing encrypted data & indexes
2020
- [Managing indexes with EQL](#managing-indexes-with-eql)
2121
- [Data Format](#data-format)
2222
- [Helper packages](#helper-packages)
23+
- [Releasing](#releasing)
2324

2425
---
2526

@@ -609,3 +610,15 @@ We have created a few langague specific packages to help you interact with the p
609610
610611
- [@cipherstash/eql](https://github.com/cipherstash/encrypt-query-language/tree/main/languages/javascript/packages/eql): This is a TypeScript implementation of EQL.
611612
- [github.com/encrypt-query-language/go/goeql](https://github.com/cipherstash/encrypt-query-language/tree/main/languages/go/goeql): This is a Go implementation of EQL.
613+
614+
## Releasing
615+
616+
To cut a [release](https://github.com/cipherstash/encrypt-query-language/releases) of EQL:
617+
618+
1. Draft a [new release](https://github.com/cipherstash/encrypt-query-language/releases/new) on GitHub
619+
1. Choose a tag, and create a new one with the prefix `eql-` followed by a [semver](https://semver.org/) (for example, `eql-1.2.3`)
620+
1. Generate the release notes
621+
1. Optionally set the release to be the latest (you can set a release to be latest later on if you are testing out a release first)
622+
1. Click the `Publish release` button
623+
624+
This will trigger a run of the [Release EQL](https://github.com/cipherstash/encrypt-query-language/actions/workflows/release-eql.yml) workflow, which will build and attach artifacts to the release.

0 commit comments

Comments
 (0)