Skip to content

Commit 199c114

Browse files
committed
document how to hotfix docs
i'd like a better link to give for the github actions, but for some reason https://github.com/dagger/container-use/actions\?query\=branch%3Adocs is empty for me. Signed-off-by: Connor Braa <connor@dagger.io>
1 parent e4e9a45 commit 199c114

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

RELEASING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,31 @@
3434
- Review and merge the PR to make the release available via Homebrew
3535

3636
The Dagger CI automatically handles building binaries and creating the draft release when tags are pushed.
37+
38+
## Docs Hotfix
39+
40+
For documentation fixes that need to be published without waiting for a full release:
41+
42+
1. **Squash-merge your documentation PR to main via Github**
43+
44+
2. **Get the SHA of the merged commit**
45+
```sh
46+
# Copy the SHA of the merged documentation commit
47+
git fetch origin main && git log origin/main
48+
```
49+
50+
3. **Cherry-pick the commit onto the docs branch**
51+
52+
```sh
53+
git checkout docs --
54+
git cherry-pick <commit-hash>
55+
```
56+
57+
4. **Push to origin**
58+
```sh
59+
git push origin docs
60+
```
61+
62+
5. **Verify publication**
63+
- Check [GitHub Commits](https://github.com/dagger/container-use/commits/docs/) to verify the docs were published successfully
64+
- The docs site should update automatically once the workflow completes

0 commit comments

Comments
 (0)