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.

Sign up for GitHub

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

Jump to bottom

Check renamed change files #580

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Check renamed change files #580

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ecb55a2
check for renamed change files
LarryKiniu Aug 12, 2021
ec64d45
update error message in case a change file was renamed
LarryKiniu Aug 12, 2021
47119e1
Change files
LarryKiniu Aug 12, 2021
2f57e7c
add test for validating when change files have been deleted or renamed
LarryKiniu Aug 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/beachball-fdbfaaed-1a31-4644-a756-9b44db0b66d1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "check for renamed change files",
"packageName": "beachball",
"email": "lkiniu@microsoft.com",
"dependentChangeType": "patch"
}
6 changes: 3 additions & 3 deletions src/validation/areChangeFilesDeleted.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ export function areChangeFilesDeleted(options: BeachballOptions): boolean {
process.exit(1);
}

console.log(`Checking for deleted change files against "${branch}"`);
console.log(`Checking for deleted and renamed change files against "${branch}"`);
Copy link
Member

Choose a reason for hiding this comment

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

I think it would make sense to rename the function too: areChangeFilesDeletedOrRenamed. A bit on verbose side, but reflects the purpose of the function :)

Copy link
Author

Choose a reason for hiding this comment

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

I suppose that would be more descriptive. However, it will break the API. There are a couple of options I can see to avoid this:

  1. Create a new more descriptive function while keeping the current one and marking it for deprecation in the future.
  2. Create a new method that just checks for renamed change files and calling it based on a flag like --disallow-renamed-change-files which can be used in conjunction with the current function.
    Which option should we go with - or are there other options?

Copy link
Member

Choose a reason for hiding this comment

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

I think option #2 makes more sense :)

Copy link
Member

Choose a reason for hiding this comment

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

@LarryKiniu This is an internal API, so you don't need to worry about breaking it. (I'm fine with either renaming the function or just going with this as-is.)

const changeFilesDeletedSinceRef = getChangesBetweenRefs(
branch,
'HEAD',
[
'--diff-filter=D', // showing only deleted files from the diff.
'--diff-filter=DR', // showing only deleted and renamed change files from the diff.
LarryKiniu marked this conversation as resolved.
Show resolved Hide resolved
],
`${changePath}/*.json`,
root
Expand All @@ -37,7 +37,7 @@ export function areChangeFilesDeleted(options: BeachballOptions): boolean {

if (changeFilesDeleted) {
const changeFiles = changeFilesDeletedSinceRef.map(file => `- ${file}`);
const errorMessage = 'The following change files were deleted:';
const errorMessage = 'The following change files were deleted or renamed:';

console.error(`${errorMessage}\n${changeFiles.join('\n')}\n`);
}
Expand Down