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

doc: add an explicit fetch tag step in release guide #53828

Closed
wants to merge 1 commit into from

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented Jul 12, 2024

I had some problems generating the CHANGELOG for the 22.5.0 proposal, turned out the reason was my local clone didn't have the v22.4.1 tag.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 12, 2024
@RedYetiDev RedYetiDev added the meta Issues and PRs related to the general management of the project. label Jul 12, 2024
@@ -285,6 +285,8 @@ You can integrate the PRs into the proposal without running full CI.
⚠️ At this point, you can either run `git node release --prepare`:

```console
$ # You need to have locally the tag of the latest release of the release line
$ git fetch http://github.com/nodejs/node.git tag -n vx.b.c
Copy link
Member

Choose a reason for hiding this comment

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

Usually git remote update would do this work, won't it? I think it's simpler than checking what was the last tag.

Copy link
Member

Choose a reason for hiding this comment

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

Wouldn't it be better if git node release checked/(optionally?) updated tags?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I do not want to fetch all the tags from the upstream, I really want to fetch what's really necessary – I'm not always in a place with good unlimited internet. I am not going to run git remote update, that's a deal breaker for me.
Updating NCU to check the version number from the changelog instead of a git tag would work.

Copy link
Member

Choose a reason for hiding this comment

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

You can also run git fetch --tags --all. Although it fetches all tags, it also considers your remote state. So, unless your remote hasn't been updated since 2020, it should be quite efficient.

But, doing it on git node release seems good to me as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So, unless your remote hasn't been updated since 2020

Believe it or not, that's probably accurate 😅 One day, a long long time ago, I've cloned the repo with --single-branch, and since then I mostly only pulled the main branch – and until I've tried to prepare a release, that has never caused any problem for me.

@aduh95
Copy link
Contributor Author

aduh95 commented Sep 24, 2024

This is no longer necessary, ncu fetches the tag now.

@aduh95 aduh95 closed this Sep 24, 2024
@aduh95 aduh95 deleted the fetch-last-release-tag branch September 24, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants