Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove references to make bump in releasing #12222

Merged
merged 3 commits into from
Mar 3, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
format
  • Loading branch information
sfoster1 committed Mar 3, 2023
commit 8d65b53c1f5ea85e257cfb36908d0363f4a70866
1 change: 1 addition & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ git merge --no-ff release
### tag usage

We specify the version of a release artifact through a specifically-formatted git tag. We consider our monorepo to support several projects: robot stack, ot3, protocol-designer, etc. Tags look like this:

```shell
${projectPrefix}${projectVersion}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
${projectPrefix}${projectVersion}
git tag -a ${projectPrefix}${projectVersion} -m 'chore(release): ${projectPrefix}${version}'

Copy link
Member Author

Choose a reason for hiding this comment

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

No, this defines the name of the tag, not the command itself. Then there's examples of tags. The commands to use are inline in the instructions.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok, then it may be worth calling out that the tag message should include the project prefix too right (e.g. chore(release): [email protected])?

Copy link
Member Author

Choose a reason for hiding this comment

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

we haven't previously been doing that (and also ot isn't a project prefix - flex uses ot3, robot stack uses v)

```
Expand Down