You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,7 +138,7 @@ This will show the raw content as stored in the repository. So even if `cat my-s
138
138
139
139
### Unlock a repository
140
140
141
-
After you freshly clone a repository which contains files which have been encrypted by `git-conceal`, you need to provide the symmetric key that your coworkers would have shared with you to decrypt it:
141
+
After you freshly clone a repository which contains files which have been encrypted by `git-conceal`, you need to provide the symmetric key (that your coworkers would have shared with you) to decrypt it:
142
142
143
143
```bash
144
144
# Option 1: Provide the Base64-encoded key directly as command line argument.
@@ -189,7 +189,7 @@ git-conceal status
189
189
This shows:
190
190
- Whether the repository is locked or unlocked
191
191
- Whether filters are configured
192
-
- Which file patterns are encrypted (from`.gitattributes`)
192
+
- Which files are handled by `git-conceal` (i.e. tracked files matching one of the patterns with `filter=git-conceal` in your`.gitattributes`)
193
193
194
194
```bash
195
195
git-conceal status <FILES>
@@ -208,7 +208,7 @@ git-conceal key show
208
208
### Rotate the encryption key
209
209
210
210
There are times when you might need to rotate the encryption key used in an encrypted repository.
211
-
For example, in the unfortunate even of the key leaking or when a coworker leaves your team/company and you want to ensure they can't access new secrets.
211
+
For example, in the unfortunate event of the key leaking, or when a coworker leaves your team/company and you want to ensure they can't access new secrets.
212
212
213
213
You can rotate the encryption key with:
214
214
@@ -248,15 +248,19 @@ For detailed security information, including key management, deterministic encry
248
248
249
249
## New releases
250
250
251
-
Releases are automated by our CI every time we make a `git tag` on the repo. Be sure to update the version in the `Cargo.toml` first though.
251
+
Releases are automated by our CI every time we make a `git tag` on the repo.
252
+
253
+
<details><summary>Release instructions for maintainers</summary>
252
254
253
255
- Create a `release/x.y.z` branch
254
256
- Edit `Cargo.toml` to update the `version = "x.y.z"` field
255
-
- Run `cargo check` to update the `Cargo.lock` and validate the code still compiles
257
+
- Run `cargo check` to update the `Cargo.lock`with the new version and validate the code still compiles
256
258
-`git add Cargo.toml Cargo.lock` then `git commit -m "Bump version to x.y.z"`
257
-
- Create a PR and get it merged
259
+
- Create a PR with those changes and get it merged into `trunk`
258
260
- Once it has landed in `trunk`, push a new tag (`git tag "x.y.z"` then `git push origin "x.y.z"`)
259
-
- Then let the CI build the release binaries for all platforms, create the GitHub Release, and attach the compiled binaries as assets.
261
+
262
+
The CI will trigger on the Git tag and take care of building the release binaries for all platforms and creating the GitHub Release with those binaries attached as assets.
0 commit comments