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(zone.js): update release guide for zone.js #55846

Closed
wants to merge 1 commit into from
Closed

Conversation

dylhunn
Copy link
Contributor

@dylhunn dylhunn commented May 17, 2024

Update the releasing guide for zone.js, because one of the release commands was outdated.

Update the releasing guide for zone.js, because one of the release commands was outdated.
@dylhunn dylhunn added area: zones target: minor This PR is targeted for the next minor release labels May 17, 2024
@ngbot ngbot bot added this to the Backlog milestone May 17, 2024
@pullapprove pullapprove bot requested a review from JiaLiPassion May 17, 2024 00:34
@angular-robot angular-robot bot added the area: docs Related to the documentation label May 17, 2024
@@ -76,7 +78,7 @@ Releasing `zone.js` is a two step process.

```
rm -rf node_modules && yarn install
export PREVIOUS_ZONE_TAG=`git tag -l 'zone.js-0.11.*' | tail -n1`
export PREVIOUS_ZONE_TAG=`git tag -l 'zone.js-0.14.*' | tail -n1`
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if we should update this command to avoid having a version and use something like this instead:

Suggested change
export PREVIOUS_ZONE_TAG=`git tag -l 'zone.js-0.14.*' | tail -n1`
export PREVIOUS_ZONE_TAG=`git describe --tags --match="zone.js*" --abbrev=0 HEAD`

We can also consider adding a couple lines to make sure that we are at the main branch and it's up to date

git fetch upstream
git checkout upstream/main

@josephperrott WDYT?

@@ -1,6 +1,8 @@
To run tests
------------

*Note*: some of these tests no longer run. Be sure to check that CI is green.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should move this content into the "Cutting a release" section, i.e. mention that a caretaker needs to make sure that the CI is "green" before starting the release process.

Copy link
Member

@josephperrott josephperrott left a comment

Choose a reason for hiding this comment

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

LGTM

@AndrewKushnir AndrewKushnir added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note and removed target: minor This PR is targeted for the next minor release labels Jun 5, 2024
@AndrewKushnir
Copy link
Contributor

Caretaker note: low risk change, no additional reviews are required.

thePunderWoman pushed a commit that referenced this pull request Jun 5, 2024
Update the releasing guide for zone.js, because one of the release commands was outdated.
PR Close #55846
@thePunderWoman
Copy link
Contributor

This PR was merged into the repository by commit 117a26b.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action: merge The PR is ready for merge by the caretaker area: docs Related to the documentation area: zones merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants