Implement changeset tag and getAllTags. Resolves #612. #634

joeldenning · 2021-09-08T23:01:46Z

See #612. This is my first pull request to this repository - let me know if I missed any steps for contributing.

changeset-bot · 2021-09-08T23:01:48Z

🦋 Changeset detected

Latest commit: 608d566

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@changesets/cli	Minor
@changesets/git	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

atlassian-cla-bot · 2021-09-08T23:01:48Z

Hooray! All contributors have signed the CLA.

packages/git/src/index.ts

packages/cli/src/commands/tag/index.ts

packages/git/src/index.ts

Andarist · 2021-10-10T20:57:41Z

packages/git/src/index.ts

@@ -26,6 +26,16 @@ async function commit(message: string, cwd: string) {
  return gitCmd.code === 0;
 }

+async function getAllTags(cwd: string): Promise<string[]> {
+  const gitCmd = await spawn("git", ["tag"], { cwd });


I'm slightly worried that tags might not always be available on CI when working with shallow gi clones and similar setups. I'm no git expert so this would require some research on the topic.

I read through https://git-scm.com/docs/git-clone and tested locally with git clone --depth=1. I saw that the tags are not included in a shallow clone with --depth=1. Also, they are not included when the --no-tags flag is passed to git clone.

Different CI/CD tools run git clone with a wide variety of flags, so there may be some tools that pass the --depth or --no-tags flag. I looked at github's actions/checkout and it allows you to configure the --depth flag but I see no mention of the --no-tags flag. This documentation indicates that it's quite easy to get all the git tags and branches, if needed, by setting the depth to 0. I didn't look at travis, circle, or any other CI/CD tools.

I'll give this a thought - I guess the answer could be: "make the user responsible for making tags available" 🤔

I think it's reasonable that the changeset tag command would require that you've cloned the tags along with the repo. It's in the name :)

docs/command-line-options.md

Andarist · 2021-10-10T21:11:56Z

docs/command-line-options.md

+
+The tag command creates git tags for the current version of all packages. The tags created are equivalent to those created by [`changeset publish`](#publish), but the `tag` command does not publish anything to npm.
+
+This is helpful in situations where a different tool, such as `pnpm publish -r`, is used to publish packages instead of changeset. For situations where `changeset publish` is executed, running `changeset tag` is unneeded. See [issue 612](https://github.com/atlassian/changesets/issues/612) for the original inspiration behind this command.


I know that currently there are some issues with pnpm, but I'm thinking about improving the story around that and implementing a better publishing strategy with changesets that would account for more situations. If that would be fixed in Changesets itself - would there still be a reason to choose pnpm publish -r over changeset publish?

This doesn't necessarily mean that changeset tag would be redundant. I guess one can always have some reasons to implement the publish part of the process on their own and changeset tag makes things more flexible for those use cases.

I know that currently there are some issues with pnpm, but I'm thinking about improving the story around that and implementing a better publishing strategy with changesets that would account for more situations. If that would be fixed in Changesets itself - would there still be a reason to choose pnpm publish -r over changeset publish?

pnpm supports workspace:* as a valid semver range value for a package.json dependency, which allows you to cross reference packages and ensure that when you publish, each package always uses the exact version of all monorepo dependencies. During publish, it replaces the workspace:* with a pinned version of the dependency. You can see that in this example where generator-single-spa is pinned to 4.1.2, even though the source code just says workspace:*. Additionally, pnpm publish -r runs all prepublish and prepublishOnly scripts in each package in the monorepo. Since I don't use changeset publish right now, I don't know how much of an overlap there is. @zkochan could comment further on any other features of pnpm publish -r that i'm unaware of

Both of the things mentioned could be supported by the changeset publish. The latter already is, since we literally call npm publish in the given directory. My plan for the former is to invoke the appropriate pack command and publish that (so replacing would happen within pnpm), this would - most likely - require us to also implement running some lifecycle scripts within changeset (instead of relying on them being executed within npm publish) but as far as I remember this (running the scripts) is exactly what pnpm does under the hood. So it looks like a valid strategy for us too.

That sounds good to me, for me it's just about getting the right behavior from whichever tools can provide it.

npm publish will not work correctly in a pnpm workspace.

@zkochan using smth like pnpm pack && npm publish lib.tar.gz would work though, right?

Andarist · 2021-10-10T21:15:15Z

.changeset/nervous-actors-protect.md

+Add `changeset tag` and `getAllTags`
+
+The `changeset tag` command creates git tags for each package.
+
+The `getAllTags` function within @changesets/git retrieves all git tags for a repository.


I think I would split this changeset file into 2. The getAllTags part is not relevant for people reading about the new feature in@changesets/cli.

Don't be afraid of describing a single PR from different angles :) Each touched package might often need a different summary of changes (the change should be - IMHO - described primarily from the perspective of that package).

👍🏿 will update

joeldenning · 2021-10-12T03:29:59Z

Thanks for the thorough review - I'm not sure when I'll have time to address the changes, but hopefully in the next week.

Andarist · 2021-10-12T05:51:27Z

@joeldenning no worries. Sorry for my late reply anyway - i was lately busy and didnt have time to work on Changesets much but i think i got some fresh energy for that (still not a lot of time though 😜). Hopefully, i should be more responsive in the coming weeks.

If you dont end up addressing the issues I will eventually pick this up and bring this through a finish line.

I would appreciate an answer on the question asked here though: #634 (comment) . Im rethinking how to reimplement publishing and this would help me to consider your use case.

joeldenning · 2021-10-19T20:50:45Z

I pushed a couple new commits addressing the feedback, and responded to your question above.

joeldenning · 2021-10-20T20:58:01Z

I've responded to all comments and think I've addressed all of the review feedback - let me know if there's anything I looked over or other things to change.

Andarist · 2021-11-01T08:33:32Z

@joeldenning thank you for your contribution and for bearing with me. I've made a TODO item for this week to land this - it's very close to that, just some nits and one last look at this. I can take care of all of that myself so we don't end up 🏓 each other any longer.

Andarist · 2021-11-07T17:43:11Z

Ufff, managed to land this before the end of the week 😉

Thank you very much for your contribution ❤️

joeldenning added 2 commits September 8, 2021 16:57

Implement changeset tag and getAllTags. Resolves changesets#612.

99b708f

Self review

503ec8e

joeldenning commented Sep 8, 2021

View reviewed changes

packages/git/src/index.ts Outdated Show resolved Hide resolved

packages/cli/src/commands/tag/index.ts Show resolved Hide resolved

Fix tests

cd08aa7

joeldenning mentioned this pull request Sep 8, 2021

Create git tags during version instead of publish #612

Closed

Andarist reviewed Oct 10, 2021

View reviewed changes

packages/git/src/index.ts Outdated Show resolved Hide resolved

Andarist reviewed Oct 10, 2021

View reviewed changes

docs/command-line-options.md Outdated Show resolved Hide resolved

Andarist reviewed Oct 10, 2021

View reviewed changes

joeldenning added 3 commits October 19, 2021 13:57

Merge branch 'main' into issue-612

f6867b2

Feedback

0e8f953

Fix formatting

f4fd47c

joeldenning added 2 commits October 20, 2021 14:54

Support for single package repos.

616f0af

Self review

5f24d65

Andarist added 3 commits November 7, 2021 11:00

Merge branch 'main' into issue-612

f49b77a

Remove redundant .filter(Boolean)

9447ac9

tweaks

c9d4d46

Andarist approved these changes Nov 7, 2021

View reviewed changes

tweak frontmatters

608d566

Andarist enabled auto-merge (squash) November 7, 2021 17:41

Andarist merged commit 2b49c39 into changesets:main Nov 7, 2021

github-actions bot mentioned this pull request Nov 7, 2021

Version Packages #663

Merged

javier-garcia-meteologica mentioned this pull request Nov 11, 2021

Separate publish / tag into two separate commands #478

Open

Andarist mentioned this pull request Dec 16, 2022

Question: Am I missing something trying to create tags? #972

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement changeset tag and getAllTags. Resolves #612. #634

Implement changeset tag and getAllTags. Resolves #612. #634

joeldenning commented Sep 8, 2021

changeset-bot bot commented Sep 8, 2021 •

edited

atlassian-cla-bot bot commented Sep 8, 2021 •

edited

Andarist Oct 10, 2021

joeldenning Oct 19, 2021 •

edited

Andarist Oct 20, 2021

joeldenning Oct 20, 2021

Andarist Oct 10, 2021 •

edited

joeldenning Oct 19, 2021 •

edited

Andarist Oct 20, 2021

joeldenning Oct 20, 2021

zkochan Oct 20, 2021

Andarist Nov 1, 2021

zkochan Nov 1, 2021

Andarist Oct 10, 2021

joeldenning Oct 19, 2021

joeldenning commented Oct 12, 2021

Andarist commented Oct 12, 2021

joeldenning commented Oct 19, 2021

joeldenning commented Oct 20, 2021

Andarist commented Nov 1, 2021

Andarist commented Nov 7, 2021


		The tag command creates git tags for the current version of all packages. The tags created are equivalent to those created by [`changeset publish`](#publish), but the `tag` command does not publish anything to npm.

		This is helpful in situations where a different tool, such as `pnpm publish -r`, is used to publish packages instead of changeset. For situations where `changeset publish` is executed, running `changeset tag` is unneeded. See [issue 612](https://github.com/atlassian/changesets/issues/612) for the original inspiration behind this command.

Implement changeset tag and getAllTags. Resolves #612. #634

Implement changeset tag and getAllTags. Resolves #612. #634

Conversation

joeldenning commented Sep 8, 2021

changeset-bot bot commented Sep 8, 2021 • edited

🦋 Changeset detected

atlassian-cla-bot bot commented Sep 8, 2021 • edited

Choose a reason for hiding this comment

joeldenning Oct 19, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Andarist Oct 10, 2021 • edited

Choose a reason for hiding this comment

joeldenning Oct 19, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joeldenning commented Oct 12, 2021

Andarist commented Oct 12, 2021

joeldenning commented Oct 19, 2021

joeldenning commented Oct 20, 2021

Andarist commented Nov 1, 2021

Andarist commented Nov 7, 2021

changeset-bot bot commented Sep 8, 2021 •

edited

atlassian-cla-bot bot commented Sep 8, 2021 •

edited

joeldenning Oct 19, 2021 •

edited

Andarist Oct 10, 2021 •

edited

joeldenning Oct 19, 2021 •

edited