Skip to content

feat(changesets-renovate): filter out private packages #2545

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
5 changes: 5 additions & 0 deletions .changeset/clean-tigers-stalk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@scaleway/changesets-renovate": minor
---

filter out private packages from being published
Original file line number Diff line number Diff line change
Expand Up @@ -451,4 +451,91 @@ describe('generate changeset file', () => {
expect(fs.readFile).toHaveBeenCalledWith(file, 'utf8')
expect(console.log).toHaveBeenCalledWith('No packages modified, skipping')
})

it('should ignore private packages', async () => {
const file = 'test/package.json'

mockSimpleGit.mockReturnValue({
...defaultGitValues,
branch: () => ({
current: 'renovate/test',
}),
diffSummary: () => ({
files: [
{
file,
},
],
}),
show: () => `
+ "package": "version"
+ "package2": "version2"
`,
})

fs.readFile = vi
.fn()
.mockResolvedValueOnce(`{}`)
.mockResolvedValueOnce(`{"name":"packageName","version":"1.0.0","private":true}`)
fs.writeFile = vi.fn()

await run()

expect(fs.readFile).toHaveBeenCalledWith(file, 'utf8')
expect(console.log).toHaveBeenCalledWith('No packages modified, skipping')
})

it('should include only non-private packages in changeset', async () => {
const rev = 'test'
const fileName = `.changeset/renovate-${rev}.md`
const privateFile = 'private/package.json'
const publicFile = 'public/package.json'
const revparse = vi.fn().mockReturnValue(rev)
const add = vi.fn()
const commit = vi.fn()
const push = vi.fn()

mockSimpleGit.mockReturnValue({
branch: () => ({
current: 'renovate/test',
}),
diffSummary: () => ({
files: [
{
file: privateFile,
},
{
file: publicFile,
},
],
}),
show: () => `
+ "package": "version"
+ "package2": "version2"
`,
revparse,
add,
commit,
push,
})

fs.readFile = vi
.fn()
.mockResolvedValueOnce(`{}`)
.mockResolvedValueOnce(`{"name":"privatePackage","version":"1.0.0","private":true}`)
.mockResolvedValueOnce(`{"name":"publicPackage","version":"1.0.0"}`)
fs.writeFile = vi.fn()

await run()

expect(fs.readFile).toHaveBeenCalledWith(privateFile, 'utf8')
expect(fs.readFile).toHaveBeenCalledWith(publicFile, 'utf8')
expect(fs.writeFile).toHaveBeenCalled()
// Only the public package should be included in the changeset
expect(fs.writeFile.mock.calls[0][1]).toContain("'publicPackage': patch")
expect(fs.writeFile.mock.calls[0][1]).not.toContain("'privatePackage': patch")
expect(add).toHaveBeenCalledWith(fileName)
expect(commit).toHaveBeenCalledWith(`chore: add changeset renovate-${rev}`)
expect(push).toHaveBeenCalledTimes(1)
})
})
6 changes: 6 additions & 0 deletions packages/changesets-renovate/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ async function getPackagesNames(files: string[]): Promise<string[]> {
name: string
workspaces?: string[]
version?: string
private?: boolean
}

if (data.private) {
return
}

if (shouldIgnorePackage(data.name, ignoredPackages)) {
Expand All @@ -54,6 +59,7 @@ async function getPackagesNames(files: string[]): Promise<string[]> {
return packages
}


async function createChangeset(
fileName: string,
packageBumps: Map<string, string>,
Expand Down