Skip to content

Commit b7f5884

Browse files
committed
fix: remove v3 banner notice
1 parent 519ad28 commit b7f5884

File tree

2 files changed

+4
-16
lines changed

2 files changed

+4
-16
lines changed

src/presets/semver-workflow.ts

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,7 @@ import path from 'path'
1515
import {readFile, writeFile} from '../util/files'
1616
import {errorToUndefined} from '../util/errorToUndefined'
1717
import {PackageJson} from '../actions/verify/types'
18-
import {
19-
developTestSnippet,
20-
getLicenseText,
21-
installationSnippet,
22-
v3BannerNotice,
23-
} from '../util/readme'
18+
import {developTestSnippet, getLicenseText, installationSnippet} from '../util/readme'
2419
import {getUserInfo} from '../util/user'
2520

2621
export const semverWorkflowPreset: Preset = {
@@ -78,10 +73,9 @@ async function updateReadme(options: InjectOptions) {
7873
const readmePath = path.join(basePath, 'README.md')
7974
const readme = (await readFile(readmePath, 'utf8').catch(errorToUndefined)) ?? ''
8075

81-
const {v3Banner, install, usage, developTest, license, releaseSnippet} =
82-
await readmeSnippets(options)
76+
const {install, usage, developTest, license, releaseSnippet} = await readmeSnippets(options)
8377

84-
const prependSections = missingSections(readme, [v3Banner, install, usage])
78+
const prependSections = missingSections(readme, [install, usage])
8579
const appendSections = missingSections(readme, [license, developTest, releaseSnippet])
8680

8781
if (prependSections.length || appendSections.length) {
@@ -117,7 +111,6 @@ async function readmeSnippets(options: InjectOptions) {
117111
`
118112

119113
return {
120-
v3Banner: v3BannerNotice(),
121114
install,
122115
usage,
123116
license,

src/util/readme.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ import {PackageData} from '../actions/inject'
55
import {User} from './user'
66

77
export function generateReadme(data: PackageData) {
8-
const {user, pluginName, license, description} = data
8+
const {user, pluginName, license} = data
99

1010
return (
1111
outdent`
1212
# ${pluginName}
1313
14-
${v3BannerNotice()}
1514
1615
${installationSnippet(pluginName ?? 'unknown')}
1716
@@ -35,10 +34,6 @@ export function generateReadme(data: PackageData) {
3534
)
3635
}
3736

38-
export function v3BannerNotice() {
39-
return `> This is a **Sanity Studio v3** plugin.`
40-
}
41-
4237
export function installationSnippet(packageName: string) {
4338
return outdent`
4439
## Installation

0 commit comments

Comments
 (0)