-
Notifications
You must be signed in to change notification settings - Fork 379
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: allow excluding file paths to filter out commits (#1875)
* feat: add exclude for manifest packages * chore: adjust ReleaserConfigJson interface * docs: update documentation * feat: read exclude-paths from configuration * chore: add license to new files * fix: include only based on relevant files * use array index, Array.prototype.at is not available in node 14 which we still support --------- Co-authored-by: Jeff Ching <[email protected]>
- Loading branch information
1 parent
fde2602
commit a9bed82
Showing
9 changed files
with
305 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| // Copyright 2023 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| import {Commit} from '../commit'; | ||
| import {ReleaserConfig, ROOT_PROJECT_PATH} from '../manifest'; | ||
| import {normalizePaths} from './commit-utils'; | ||
|
|
||
| export type CommitExcludeConfig = Pick<ReleaserConfig, 'excludePaths'>; | ||
|
|
||
| export class CommitExclude { | ||
| private excludePaths: Record<string, string[]> = {}; | ||
|
|
||
| constructor(config: Record<string, CommitExcludeConfig>) { | ||
| Object.entries(config).forEach(([path, releaseConfig]) => { | ||
| if (releaseConfig.excludePaths) { | ||
| this.excludePaths[path] = normalizePaths(releaseConfig.excludePaths); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| excludeCommits<T extends Commit>( | ||
| commitsPerPath: Record<string, T[]> | ||
| ): Record<string, T[]> { | ||
| const filteredCommitsPerPath: Record<string, T[]> = {}; | ||
| Object.entries(commitsPerPath).forEach(([path, commits]) => { | ||
| if (this.excludePaths[path]) { | ||
| commits = commits.filter(commit => | ||
| this.shouldInclude(commit, this.excludePaths[path], path) | ||
| ); | ||
| } | ||
| filteredCommitsPerPath[path] = commits; | ||
| }); | ||
| return filteredCommitsPerPath; | ||
| } | ||
|
|
||
| private shouldInclude( | ||
| commit: Commit, | ||
| excludePaths: string[], | ||
| packagePath: string | ||
| ): boolean { | ||
| return ( | ||
| !commit.files || | ||
| !commit.files | ||
| .filter(file => this.isRelevant(file, packagePath)) | ||
| .every(file => excludePaths.some(path => this.isRelevant(file, path))) | ||
| ); | ||
| } | ||
|
|
||
| private isRelevant(file: string, path: string) { | ||
| return path === ROOT_PROJECT_PATH || file.indexOf(`${path}/`) === 0; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| // Copyright 2023 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| export const normalizePaths = (paths: string[]) => { | ||
| return paths.map(path => { | ||
| // normalize so that all paths have leading and trailing slashes for | ||
| // non-overlap validation. | ||
| // NOTE: GitHub API always returns paths using the `/` separator, | ||
| // regardless of what platform the client code is running on | ||
| let newPath = path.replace(/\/$/, ''); | ||
| newPath = newPath.replace(/^\//, ''); | ||
| newPath = newPath.replace(/$/, '/'); | ||
| newPath = newPath.replace(/^/, '/'); | ||
| // store them with leading and trailing slashes removed. | ||
| newPath = newPath.replace(/\/$/, ''); | ||
| newPath = newPath.replace(/^\//, ''); | ||
| return newPath; | ||
| }); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "release-type": "simple", | ||
| "label": "custom: pending", | ||
| "release-label": "custom: tagged", | ||
| "exclude-paths": ["path-ignore"], | ||
| "packages": { | ||
| ".": { | ||
| "component": "root", | ||
| "exclude-paths": ["path-root-ignore"] | ||
| }, | ||
| "node-lib": { | ||
| "component": "node-lib" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.