Skip to content

Commit

Permalink
PLT-8890 - Stop automatic doc deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
hrajchert committed Dec 7, 2023
1 parent ce594ac commit 2f266ff
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
name: Post integration
name: Deploy docs
env:
ALLOWED_URIS: "https://github.com https://api.github.com"
TRUSTED_PUBLIC_KEYS: "cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= marlowe-temp.cachix.org-1:1gPjVFpu4QjaAT3tRurCioX+BC23V7mjvFwpP5bV0Ec= loony-tools:pr9m4BkM/5/eSTZlkQyRt57Jz7OMBxNSUiMC4FkcNfk="
SUBSTITUTERS: "https://cache.nixos.org/ https://cache.iog.io https://marlowe-temp.cachix.org https://cache.zw3rk.com/"

on:
push:
branches:
- main
on: workflow_dispatch

permissions:
contents: read
Expand Down
14 changes: 12 additions & 2 deletions doc/versioning-and-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,27 @@ Before version 1, the TS-SDK adheres to beta rules:
1. **Release Notes:**

- Generate release notes from the `changelog.d` folder(s).
- This can be done using `scriv collect` from the nix shell.

2. **Release Tag:**

- Create and push a release tag.
- Use git to create and push a release tag.
- `git tag -a 0.3.0-beta -m "Release v0.3.0-beta"`
- `git push --tags`

3. **Packages Build and Publish:**

- Build and publish packages from the release tag.
- `npm publish --workspaces` (for the moment @hrajchert and @nhenin have publish access)

4. **GitHub Release:**
- Publish release(s) on GitHub along with release notes.
- Publish release(s) on GitHub along with release notes from the collected changelog.

5. **Documentation:**
- Manually trigger the `deploy docs` github action

6. **Announcement:**
- Contact the marketing and devrel team to announce the release.

## Note:

Expand Down

0 comments on commit 2f266ff

Please sign in to comment.