paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 42 Packages Projects Releases Wiki Activity

more api cleanup

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-08-18 14:11:45 +02:00
parent e195112c5c
commit 3f739be9d9
88 changed files with 358 additions and 594 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/git-release-manager/api-report.md
+7 -30
View File
@@ -90,7 +90,6 @@ const DISABLE_CACHE: {
const Divider: () => JSX.Element;
// Warning: (ae-forgotten-export) The symbol "SemverTagParts" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "getBumpedSemverTagParts" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
function getBumpedSemverTagParts(
@@ -105,14 +104,8 @@ function getBumpedSemverTagParts(
};
};
// Warning: (ae-missing-release-tag) "getBumpedTag" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
function getBumpedTag({
project,
tag,
bumpLevel,
}: {
function getBumpedTag(options: {
project: Project;
tag: string;
bumpLevel: keyof typeof SEMVER_PARTS;
@@ -167,10 +160,8 @@ function getSemverTagParts(tag: string):
// @public (undocumented)
function getShortCommitHash(hash: string): string;
// Warning: (ae-missing-release-tag) "getTagParts" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
function getTagParts({ project, tag }: { project: Project; tag: string }):
function getTagParts(options: { project: Project; tag: string }):
| {
error: AlertError;
tagParts?: undefined;
@@ -207,14 +198,8 @@ export const gitReleaseManagerPlugin: BackstagePlugin<
{}
>;
// Warning: (ae-missing-release-tag) "InfoCardPlus" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
const InfoCardPlus: ({
children,
}: {
children?: React_2.ReactNode;
}) => JSX.Element;
const InfoCardPlus: (props: { children?: React_2.ReactNode }) => JSX.Element;
// Warning: (ae-missing-release-tag) "internals" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
@@ -625,16 +610,8 @@ declare namespace testIds {
export { TEST_IDS };
}
// Warning: (ae-missing-release-tag) "validateTagName" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
const validateTagName: ({
project,
tagName,
}: {
project: Project;
tagName?: string | undefined;
}) =>
const validateTagName: (options: { project: Project; tagName?: string }) =>
| {
tagNameError: null;
}
@@ -653,9 +630,9 @@ const VERSIONING_STRATEGIES: {
// Warnings were encountered during analysis:
//
// src/components/ResponseStepDialog/LinearProgressWithLabel.d.ts:5:5 - (ae-forgotten-export) The symbol "ResponseStep" needs to be exported by the entry point index.d.ts
// src/helpers/getBumpedTag.d.ts:14:5 - (ae-forgotten-export) The symbol "Project" needs to be exported by the entry point index.d.ts
// src/helpers/getBumpedTag.d.ts:19:5 - (ae-forgotten-export) The symbol "CalverTagParts" needs to be exported by the entry point index.d.ts
// src/helpers/getBumpedTag.d.ts:31:5 - (ae-forgotten-export) The symbol "AlertError" needs to be exported by the entry point index.d.ts
// src/helpers/getBumpedTag.d.ts:16:5 - (ae-forgotten-export) The symbol "Project" needs to be exported by the entry point index.d.ts
// src/helpers/getBumpedTag.d.ts:21:5 - (ae-forgotten-export) The symbol "CalverTagParts" needs to be exported by the entry point index.d.ts
// src/helpers/getBumpedTag.d.ts:33:5 - (ae-forgotten-export) The symbol "AlertError" needs to be exported by the entry point index.d.ts
// src/index.d.ts:9:5 - (ae-forgotten-export) The symbol "components" needs to be exported by the entry point index.d.ts
// src/index.d.ts:10:5 - (ae-forgotten-export) The symbol "constants" needs to be exported by the entry point index.d.ts
// src/index.d.ts:11:5 - (ae-forgotten-export) The symbol "helpers" needs to be exported by the entry point index.d.ts
plugins/git-release-manager/src/components/InfoCardPlus.tsx
+3 -3
View File
@@ -17,7 +17,6 @@
import React from 'react';
import { makeStyles } from '@material-ui/core';
import { TEST_IDS } from '../test-helpers/test-ids';
import { InfoCard } from '@backstage/core-components';
const useStyles = makeStyles(() => ({
@@ -26,7 +25,8 @@ const useStyles = makeStyles(() => ({
},
}));
export const InfoCardPlus = ({ children }: { children?: React.ReactNode }) => {
/** @public */
export const InfoCardPlus = (props: { children?: React.ReactNode }) => {
const classes = useStyles();
return (
@@ -34,7 +34,7 @@ export const InfoCardPlus = ({ children }: { children?: React.ReactNode }) => {
style={{ position: 'relative' }}
data-testid={TEST_IDS.info.infoFeaturePlus}
>
<InfoCard className={classes.feature}>{children}</InfoCard>
<InfoCard className={classes.feature}>{props.children}</InfoCard>
</div>
);
};
plugins/git-release-manager/src/helpers/getBumpedTag.ts
+8 -5
View File
@@ -28,16 +28,15 @@ import { SemverTagParts } from './tagParts/getSemverTagParts';
*
* For semantic versioning this means either a minor or a patch bump
* depending on the value of `bumpLevel`
*
* @public
*/
export function getBumpedTag({
project,
tag,
bumpLevel,
}: {
export function getBumpedTag(options: {
project: Project;
tag: string;
bumpLevel: keyof typeof SEMVER_PARTS;
}) {
const { project, tag, bumpLevel } = options;
const tagParts = getTagParts({ project, tag });
if (tagParts.error !== undefined) {
@@ -53,6 +52,7 @@ export function getBumpedTag({
return getBumpedSemverTag(tagParts.tagParts, bumpLevel);
}
/** @public */
function getPatchedCalverTag(tagParts: CalverTagParts) {
const bumpedTagParts: CalverTagParts = {
...tagParts,
@@ -67,6 +67,7 @@ function getPatchedCalverTag(tagParts: CalverTagParts) {
};
}
/** @public */
function getBumpedSemverTag(
tagParts: SemverTagParts,
semverBumpLevel: keyof typeof SEMVER_PARTS,
@@ -85,6 +86,8 @@ function getBumpedSemverTag(
/**
* Calculates the next semantic version, taking into account
* whether or not it's a minor or patch
*
* @public
*/
export function getBumpedSemverTagParts(
tagParts: SemverTagParts,
plugins/git-release-manager/src/helpers/tagParts/getTagParts.ts
+6 -10
View File
@@ -21,17 +21,13 @@ import { Project } from '../../contexts/ProjectContext';
/**
* Tag parts are the individual parts of a version, e.g. <major>.<minor>.<patch>
* are the parts of a semantic version
*
* @public
*/
export function getTagParts({
project,
tag,
}: {
project: Project;
tag: string;
}) {
if (project.versioningStrategy === 'calver') {
return getCalverTagParts(tag);
export function getTagParts(options: { project: Project; tag: string }) {
if (options.project.versioningStrategy === 'calver') {
return getCalverTagParts(options.tag);
}
return getSemverTagParts(tag);
return getSemverTagParts(options.tag);
}
plugins/git-release-manager/src/helpers/tagParts/validateTagName.ts
+4 -5
View File
@@ -18,13 +18,13 @@ import { getCalverTagParts } from './getCalverTagParts';
import { getSemverTagParts } from './getSemverTagParts';
import { Project } from '../../contexts/ProjectContext';
export const validateTagName = ({
project,
tagName,
}: {
/** @public */
export const validateTagName = (options: {
project: Project;
tagName?: string;
}) => {
const { project, tagName } = options;
if (!tagName) {
return {
tagNameError: null,
@@ -33,7 +33,6 @@ export const validateTagName = ({
if (project.versioningStrategy === 'calver') {
const { error } = getCalverTagParts(tagName);
return {
tagNameError: error,
};