backstage

1
/*
2
 * Copyright 2021 The Backstage Authors
3
 *
4
 * Licensed under the Apache License, Version 2.0 (the "License");
5
 * you may not use this file except in compliance with the License.
6
 * You may obtain a copy of the License at
7
 *
8
 *     http://www.apache.org/licenses/LICENSE-2.0
9
 *
10
 * Unless required by applicable law or agreed to in writing, software
11
 * distributed under the License is distributed on an "AS IS" BASIS,
12
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
 * See the License for the specific language governing permissions and
14
 * limitations under the License.
15
 */
16

17
const {
18
  default: defaultChangelogFunctions,
19
} = require('@changesets/cli/changelog');
20

21
// Custom CHANGELOG generation for changesets, stolen from here with one minor change:
22
// https://github.com/atlassian/changesets/blob/main/packages/cli/src/changelog/index.ts
23
async function getDependencyReleaseLine(changesets, dependenciesUpdated) {
24
  if (dependenciesUpdated.length === 0) return '';
25

26
  const updatedDependenciesList = dependenciesUpdated.map(
27
    dependency => `  - ${dependency.name}@${dependency.newVersion}`,
28
  );
29

30
  // Return one `Updated dependencies` bullet instead of repeating for each changeset; this
31
  // sacrifices the commit shas for brevity.
32
  return ['- Updated dependencies', ...updatedDependenciesList].join('\n');
33
}
34

35
module.exports = {
36
  getReleaseLine: defaultChangelogFunctions.getReleaseLine,
37
  getDependencyReleaseLine,
38
};
39