chore: clarify function names

Signed-off-by: Johan Haals <johan.haals@gmail.com>

packages/cli/src/commands/versions/bump.ts

@@ -33,8 +33,8 @@ import { forbiddenDuplicatesFilter } from './lint';
 import { BACKSTAGE_JSON } from '@backstage/cli-common';
 import { runParallelWorkers } from '../../lib/parallel';
 import {
-  getByReleaseLine,
-  getByVersion,
+  getManifestByReleaseLine,
+  getManifestByVersion,
   ReleaseManifest,
 } from '@backstage/release-manifests';
 
@@ -69,12 +69,14 @@ export default async (cmd: Command) => {
   let findTargetVersion: (name: string) => Promise<string>;
   let releaseManifest: ReleaseManifest;
   if (semver.valid(cmd.release)) {
-    releaseManifest = await getByVersion({ version: cmd.release });
+    releaseManifest = await getManifestByVersion({ version: cmd.release });
     findTargetVersion = createStrictVersionFinder({
       releaseManifest,
     });
   } else {
-    releaseManifest = await getByReleaseLine({ releaseLine: cmd.release });
+    releaseManifest = await getManifestByReleaseLine({
+      releaseLine: cmd.release,
+    });
     findTargetVersion = createVersionFinder({
       releaseLine: cmd.releaseLine,
       releaseManifest,

packages/release-manifests/api-report.md

@@ -4,22 +4,22 @@
 
 ```ts
 // @public
-export function getByReleaseLine(
-  options: GetByReleaseLineOptions,
+export function getManifestByReleaseLine(
+  options: GetManifestByReleaseLineOptions,
 ): Promise<ReleaseManifest>;
 
 // @public
-export type GetByReleaseLineOptions = {
+export type GetManifestByReleaseLineOptions = {
   releaseLine: string;
 };
 
 // @public
-export function getByVersion(
-  options: GetByVersionOptions,
+export function getManifestByVersion(
+  options: GetManifestByVersionOptions,
 ): Promise<ReleaseManifest>;
 
 // @public
-export type GetByVersionOptions = {
+export type GetManifestByVersionOptions = {
   version: string;
 };
 

packages/release-manifests/src/index.ts

@@ -20,9 +20,9 @@
  * @packageDocumentation
  */
 
-export { getByVersion, getByReleaseLine } from './manifest';
+export { getManifestByVersion, getManifestByReleaseLine } from './manifest';
 export type {
   ReleaseManifest,
-  GetByReleaseLineOptions,
-  GetByVersionOptions,
+  GetManifestByReleaseLineOptions,
+  GetManifestByVersionOptions,
 } from './manifest';

packages/release-manifests/src/manifest.test.ts

@@ -15,11 +15,11 @@
  */
 
 import { setupRequestMockHandlers } from '@backstage/test-utils';
-import { getByReleaseLine, getByVersion } from './manifest';
+import { getManifestByReleaseLine, getManifestByVersion } from './manifest';
 import { setupServer } from 'msw/node';
 import { rest } from 'msw';
 
-describe('getByVersion', () => {
+describe('getManifestByVersion', () => {
   const worker = setupServer();
   setupRequestMockHandlers(worker);
 
@@ -38,7 +38,7 @@ describe('getByVersion', () => {
       ),
     );
 
-    const pkgs = await getByVersion({ version: '0.0.0' });
+    const pkgs = await getManifestByVersion({ version: '0.0.0' });
     expect(pkgs.packages).toEqual([
       {
         name: '@backstage/core',
@@ -46,13 +46,13 @@ describe('getByVersion', () => {
       },
     ]);
 
-    await expect(getByVersion({ version: '999.0.1' })).rejects.toThrow(
+    await expect(getManifestByVersion({ version: '999.0.1' })).rejects.toThrow(
       'No release found for 999.0.1 version',
     );
   });
 });
 
-describe('getByReleaseLine', () => {
+describe('getManifestByReleaseLine', () => {
   const worker = setupServer();
   setupRequestMockHandlers(worker);
 
@@ -71,7 +71,7 @@ describe('getByReleaseLine', () => {
       ),
     );
 
-    const pkgs = await getByReleaseLine({ releaseLine: 'main' });
+    const pkgs = await getManifestByReleaseLine({ releaseLine: 'main' });
     expect(pkgs.packages).toEqual([
       {
         name: '@backstage/core',
@@ -79,8 +79,8 @@ describe('getByReleaseLine', () => {
       },
     ]);
 
-    await expect(getByReleaseLine({ releaseLine: 'foo' })).rejects.toThrow(
-      "No 'foo' release line found",
-    );
+    await expect(
+      getManifestByReleaseLine({ releaseLine: 'foo' }),
+    ).rejects.toThrow("No 'foo' release line found");
   });
 });

packages/release-manifests/src/manifest.ts

@@ -31,7 +31,7 @@ export type ReleaseManifest = {
  * Options for getByVersion.
  * @public
  */
-export type GetByVersionOptions = {
+export type GetManifestByVersionOptions = {
   version: string;
 };
 
@@ -39,8 +39,8 @@ export type GetByVersionOptions = {
  * Returns a release manifest based on supplied version.
  * @public
  */
-export async function getByVersion(
-  options: GetByVersionOptions,
+export async function getManifestByVersion(
+  options: GetManifestByVersionOptions,
 ): Promise<ReleaseManifest> {
   const url = `${VERSIONS_DOMAIN}/v1/releases/${encodeURIComponent(
     options.version,
@@ -61,7 +61,7 @@ export async function getByVersion(
  * Options for getByReleaseLine.
  * @public
  */
-export type GetByReleaseLineOptions = {
+export type GetManifestByReleaseLineOptions = {
   releaseLine: string;
 };
 
@@ -69,8 +69,8 @@ export type GetByReleaseLineOptions = {
  * Returns a release manifest based on supplied release line.
  * @public
  */
-export async function getByReleaseLine(
-  options: GetByReleaseLineOptions,
+export async function getManifestByReleaseLine(
+  options: GetManifestByReleaseLineOptions,
 ): Promise<ReleaseManifest> {
   const url = `${VERSIONS_DOMAIN}/v1/tags/${encodeURIComponent(
     options.releaseLine,