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

chores(releases): rename script and add info note #3815

Merged
merged 1 commit into from
Aug 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
3 changes: 3 additions & 0 deletions website/contributing/_markdown-older-bump-script.mdx
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 it's fine for now, but since 0.69 is out of support already, maybe we can remove this note in not-so-distant future?

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:::info
For versions older than 0.70, you need to run `./scripts/bump-oss-version.js` instead.
:::
7 changes: 5 additions & 2 deletions website/contributing/release-branch-cut-and-rc0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Branch Cut & RC0
---

import AsyncTestingNote from './\_markdown-async-testing-note.mdx';
import BumpOSSNote from './\_markdown-older-bump-script.mdx';
import GHReleasesNotesPrerelease from './\_markdown-GH-release-notes-prerelease.mdx';
import RoadToReleaseTemplate from './\_markdown-road-to-release-template.mdx';

Expand Down Expand Up @@ -63,11 +64,13 @@ Before continuing further, follow the [testing guide](/contributing/release-test

Once you're done with the testing, you can kick-off the bump and publishing of RC0:

```
```bash
# This will walk you through what version you are releasing
./scripts/bump-oss-version.js --to-version 0.69.0-rc.0 --token <YOUR_CIRCLE_CI_TOKEN>
yarn trigger-react-native-release --to-version 0.69.0-rc.0 --token <YOUR_CIRCLE_CI_TOKEN>
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
yarn trigger-react-native-release --to-version 0.69.0-rc.0 --token <YOUR_CIRCLE_CI_TOKEN>
yarn trigger-react-native-release --to-version 0.y.0-rc.0 --token <YOUR_CIRCLE_CI_TOKEN>

We use this format elsewhere, so we might as well can align here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the entire page is using 0.69 as the example version, so I'd rather keep it consistent across the page. Someone as a follow up PR (maybe in 6 months or so, to connect to your other comment) could do a pass on all the release pages and update them to change both the example code and remove "old versions" references. In quite a few pages we have things like "before 0.71" or even "before 0.68".
So maybe by the time 0.74 comes around (this Q4 or early next year) that would be a good time to give an overall pass to the whole section to remove old references.

```

<BumpOSSNote/>

- Once you have run that script, head to CircleCI and you should see under the releases workflow, a `prepare-package-for-release` job.

<figure>
Expand Down
7 changes: 5 additions & 2 deletions website/contributing/release-candidate-patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: RC Patches

import AsyncTestingNote from './\_markdown-async-testing-note.mdx';
import GHReleasesNotesPrerelease from './\_markdown-GH-release-notes-prerelease.mdx';
import BumpOSSNote from './\_markdown-older-bump-script.mdx';

:::info
Documents in this section go over steps to run different types of React Native release updates. Its intended audience is those in [relevant release roles](./release-roles-responsibilites.md).
Expand Down Expand Up @@ -46,17 +47,19 @@ Before continuing further, follow the [testing guide](/contributing/release-test

<AsyncTestingNote/>

### 4. Run `bump-oss-version` script
### 4. Run `trigger-react-native-release` script

```bash
# once verified all the cherry-picked commits, we can push them to remote
git push

# run a script to bump the version
# You **do not** want this release marked as "latest"!
./scripts/bump-oss-version.js --to-version 0.y.0-rc.x --token <YOUR_CIRCLE_CI_TOKEN>
yarn trigger-react-native-release --to-version 0.y.0-rc.x --token <YOUR_CIRCLE_CI_TOKEN>
```

<BumpOSSNote />

### 5. Watch CircleCI to ensure right jobs are being triggered

- Once you have run the bump script script, head to CircleCI and you should see under the releases workflow, a `prepare-package-for-release` job.
Expand Down
6 changes: 5 additions & 1 deletion website/contributing/release-stable-minor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: release-stable-minor
title: Minor Stable 0.Y.0
---

import BumpOSSNote from './\_markdown-older-bump-script.mdx';

:::info
Documents in this section go over steps to run different types of React Native release updates. Its intended audience is those in [relevant release roles](./release-roles-responsibilites.md).
:::
Expand All @@ -23,12 +25,14 @@ Documents in this section go over steps to run different types of React Native r
# Make sure you are on the release branch of the version
git checkout -b 0.Y-stable

./scripts/bump-oss-version.js --to-version 0.Y.0 --token <YOUR_CIRCLE_CI_TOKEN>
yarn trigger-react-native-release --to-version 0.Y.0 --token <YOUR_CIRCLE_CI_TOKEN>
> Do you want this to be latest?
# Reply to this prompt with "yes".
# This updates npm registry to point to this version as "latest"
```

<BumpOSSNote />

When this is done, all the other PRs (changelog, documentation, blog post) should also get merged.

### 2. Update the GitHub releases
Expand Down
7 changes: 5 additions & 2 deletions website/contributing/release-stable-patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Minor Stable Patches
---

import AsyncTestingNote from './\_markdown-async-testing-note.mdx';
import BumpOSSNote from './\_markdown-older-bump-script.mdx';

:::info
Documents in this section go over steps to run different types of React Native release updates. Its intended audience is those in [relevant release roles](./release-roles-responsibilites.md).
Expand Down Expand Up @@ -62,17 +63,19 @@ Before continuing further, follow the [testing guide](/contributing/release-test

<AsyncTestingNote/>

### 4. Run `bump-oss-version` script
### 4. Run `trigger-react-native-release` script

```bash
# once verified all the cherry-picked commits, we can push them to remote
git push

# run a script to bump the version
# If you are doing this patch release for the current latest minor, then mark it as "latest"
./scripts/bump-oss-version.js --to-version x.y.z --token <YOUR_CIRCLE_CI_TOKEN>
yarn trigger-react-native-release --to-version x.y.z --token <YOUR_CIRCLE_CI_TOKEN>
```

<BumpOSSNote />

### 5. Watch CircleCI to ensure right jobs are being triggered

- Once you have run the bump script script, head to CircleCI and you should see under the releases workflow, a `prepare-package-for-release` job.
Expand Down