Skip to content

docs(release): Update publishing procedure#1340

Open
mjameswh wants to merge 11 commits intotemporalio:mainfrom
mjameswh:publish-instructions
Open

docs(release): Update publishing procedure#1340
mjameswh wants to merge 11 commits intotemporalio:mainfrom
mjameswh:publish-instructions

Conversation

@mjameswh
Copy link
Copy Markdown
Contributor

@mjameswh mjameswh commented Jan 12, 2024

What was changed

  • Updated publishing procedure

Why?

  • They are outdated, and it is desirable that everyone in the team knows what are our current processes

Notes

  • Work is in progress to automate most of this to GHA workflows.
    These instructions reflect the current, de facto process, not the desired long term vision of how we should be releasing this project.

@mjameswh mjameswh marked this pull request as ready for review September 24, 2024 20:45
@mjameswh mjameswh requested a review from a team as a code owner September 24, 2024 20:45
@mjameswh mjameswh changed the title [WIP] Update publishing procedure docs(release): Update publishing procedure Sep 25, 2024
@mjameswh mjameswh enabled auto-merge (squash) September 25, 2024 01:47
Copy link
Copy Markdown
Contributor Author

@mjameswh mjameswh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sample repo now uses PNPM

Comment thread scripts/publish.sh Outdated
Comment thread scripts/publish.sh
Comment thread scripts/publish.sh

gh repo set-default temporalio/sdk-typescript
gh pr create
# Get PR approved and merged
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add a pause point here so the user has time to get the PR merged. Right now it will immediately checkout main before the PR has a chance to merge.

Comment thread scripts/publish.sh
set -euo pipefail

local workdir=$( mktemp -d -t sdk-typescript-release )
trap 'cd / && rm -rf "$workdir"' EXIT
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a little aggressive, we might want to just suggest to end user to clean up. If a pnpm publish fails, we lose all progress and have to start from 0

Comment thread scripts/publish.sh
exit 1
fi

git clone --branch $source_branch --depth 1 --shallow-submodules --recurse-submodules https://github.com/temporalio/sdk-typescript.git
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With GitHub removing password auth for HTTPS Git ops using SSH is a easier IMO than creating and using a PAT.

Suggested change
git clone --branch $source_branch --depth 1 --shallow-submodules --recurse-submodules https://github.com/temporalio/sdk-typescript.git
git clone --branch $source_branch --depth 1 --shallow-submodules --recurse-submodules org-56493103@github.com:temporalio/sdk-typescript.git

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants