From 33aa168c2b285a1a098c23df4b5d9ca725d79aea Mon Sep 17 00:00:00 2001 From: Erik Engervall Date: Tue, 13 Apr 2021 09:39:39 +0200 Subject: [PATCH] Replace references to GHE with GitHub Signed-off-by: Erik Engervall --- .../release-manager-as-a-service/README.md | 12 ++-- .../src/ReleaseManagerAsAService.tsx | 2 +- .../src/api/RMaaSApiClient.ts | 12 ++-- .../src/cards/createRc/CreateRc.test.tsx | 6 +- .../src/cards/createRc/CreateRc.tsx | 53 +++++++++--------- ...heInfo.test.ts => getRcGitHubInfo.test.ts} | 16 +++--- .../{getRcGheInfo.ts => getRcGitHubInfo.ts} | 2 +- .../{createGheRc.test.ts => createRc.test.ts} | 12 ++-- .../{createGheRc.ts => createRc.ts} | 24 ++++---- .../src/cards/info/Info.tsx | 22 ++++---- .../cards/info/{rmaas-flow.png => flow.png} | Bin .../src/cards/patchRc/PatchBody.tsx | 40 ++++++------- .../src/cards/promoteRc/PromoteRc.tsx | 4 +- .../src/cards/promoteRc/PromoteRcBody.tsx | 20 ++++--- ...promoteGheRc.test.ts => promoteRc.test.ts} | 6 +- .../{promoteGheRc.ts => promoteRc.ts} | 6 +- .../src/components/Differ.tsx | 4 +- .../src/components/NoLatestRelease.tsx | 2 +- .../src/test-helpers/test-helpers.test.ts | 2 +- .../src/test-helpers/test-helpers.ts | 4 +- 20 files changed, 128 insertions(+), 121 deletions(-) rename plugins/release-manager-as-a-service/src/cards/createRc/{getRcGheInfo.test.ts => getRcGitHubInfo.test.ts} (84%) rename plugins/release-manager-as-a-service/src/cards/createRc/{getRcGheInfo.ts => getRcGitHubInfo.ts} (98%) rename plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/{createGheRc.test.ts => createRc.test.ts} (92%) rename plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/{createGheRc.ts => createRc.ts} (85%) rename plugins/release-manager-as-a-service/src/cards/info/{rmaas-flow.png => flow.png} (100%) rename plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/{promoteGheRc.test.ts => promoteRc.test.ts} (90%) rename plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/{promoteGheRc.ts => promoteRc.ts} (95%) diff --git a/plugins/release-manager-as-a-service/README.md b/plugins/release-manager-as-a-service/README.md index ffb39f2c8f..46e45f9ca5 100644 --- a/plugins/release-manager-as-a-service/README.md +++ b/plugins/release-manager-as-a-service/README.md @@ -4,19 +4,19 @@ `RMaaS` enables developers to manage their releases without having to juggle git commands. -Does it bundle and ship your code? **No**. +Does it build and ship your code? **No**. What `RMaaS` does is manage your **[releases](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/managing-releases-in-a-repository)** on GitHub, building and shipping is entirely up to you as a developer to handle in your CI. -`RMaaS` is build with industry standards in mind and the flow is as follows: +`RMaaS` is built with industry standards in mind and the flow is as follows: -![](./src/cards/info/rmaas-flow.png) +![](./src/cards/info/flow.png) -> **GitHub Enterprise (GHE)**: The source control system where releases reside in a practical sense. Read more about GitHub releases here. Note that this plugin works just as well with a non-enterprise account. +> **GitHub**: The source control system where releases reside in a practical sense. Read more about GitHub releases [here](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/. Note that this plugin works just as well with GitHub Enterprise) > -> **Release Candidate (RC)**: A GHE pre-release intended primarily for internal testing +> **Release Candidate (RC)**: A GitHub pre-release intended primarily for internal testing > -> **Release Version**: A GHE release intended for end users +> **Release Version**: A GitHub release intended for end users Looking at the flow above, a common release lifecycle could be: diff --git a/plugins/release-manager-as-a-service/src/ReleaseManagerAsAService.tsx b/plugins/release-manager-as-a-service/src/ReleaseManagerAsAService.tsx index 35fd88b03f..b79c492bbb 100644 --- a/plugins/release-manager-as-a-service/src/ReleaseManagerAsAService.tsx +++ b/plugins/release-manager-as-a-service/src/ReleaseManagerAsAService.tsx @@ -85,7 +85,7 @@ export function ReleaseManagerAsAService({ return (
- +
diff --git a/plugins/release-manager-as-a-service/src/api/RMaaSApiClient.ts b/plugins/release-manager-as-a-service/src/api/RMaaSApiClient.ts index e67d50e46a..fb4ad0daa7 100644 --- a/plugins/release-manager-as-a-service/src/api/RMaaSApiClient.ts +++ b/plugins/release-manager-as-a-service/src/api/RMaaSApiClient.ts @@ -28,7 +28,7 @@ import { GhUpdateReleaseResponse, } from '../types/types'; import { CalverTagParts } from '../helpers/tagParts/getCalverTagParts'; -import { getRcGheInfo } from '../cards/createRc/getRcGheInfo'; +import { getRcGitHubInfo } from '../cards/createRc/getRcGitHubInfo'; import { PluginApiClientConfig } from './PluginApiClientConfig'; import { SemverTagParts } from '../helpers/tagParts/getSemverTagParts'; @@ -165,10 +165,10 @@ export class RMaaSApiClient { }, createRelease: async ({ - nextGheInfo, + nextGitHubInfo, releaseBody, }: { - nextGheInfo: ReturnType; + nextGitHubInfo: ReturnType; releaseBody: string; }) => { const { octokit } = await this.pluginApiClient.getOctokit(); @@ -177,9 +177,9 @@ export class RMaaSApiClient { await octokit.request(`${this.githubCommonPath}/releases`, { method: 'POST', data: { - tag_name: nextGheInfo.rcReleaseTag, - name: nextGheInfo.releaseName, - target_commitish: nextGheInfo.rcBranch, + tag_name: nextGitHubInfo.rcReleaseTag, + name: nextGitHubInfo.releaseName, + target_commitish: nextGitHubInfo.rcBranch, body: releaseBody, prerelease: true, }, diff --git a/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.test.tsx b/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.test.tsx index d4dba6841e..07582351e8 100644 --- a/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.test.tsx +++ b/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.test.tsx @@ -18,7 +18,7 @@ import { render } from '@testing-library/react'; import { mockCalverProject, - mockNextGheInfo, + mockNextGitHubInfo, mockRcRelease, mockReleaseBranch, mockReleaseVersion, @@ -30,8 +30,8 @@ import { TEST_IDS } from '../../test-helpers/test-ids'; jest.mock('../../components/ProjectContext', () => ({ useApiClientContext: () => mockApiClient, })); -jest.mock('./getRcGheInfo', () => ({ - getRcGheInfo: () => mockNextGheInfo, +jest.mock('./getRcGitHubInfo', () => ({ + getRcGitHubInfo: () => mockNextGitHubInfo, })); import { CreateRc } from './CreateRc'; diff --git a/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.tsx b/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.tsx index 22877ec1a3..8c4a5bff87 100644 --- a/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.tsx +++ b/plugins/release-manager-as-a-service/src/cards/createRc/CreateRc.tsx @@ -25,9 +25,9 @@ import { } from '@material-ui/core'; import { useAsyncFn } from 'react-use'; -import { createGheRc } from './sideEffects/createGheRc'; +import { createRc } from './sideEffects/createRc'; import { Differ } from '../../components/Differ'; -import { getRcGheInfo } from './getRcGheInfo'; +import { getRcGitHubInfo } from './getRcGitHubInfo'; import { InfoCardPlus } from '../../components/InfoCardPlus'; import { ComponentConfigCreateRc, @@ -66,37 +66,37 @@ export const CreateRc = ({ const [semverBumpLevel, setSemverBumpLevel] = useState<'major' | 'minor'>( SEMVER_PARTS.minor, ); - const [nextGheInfo, setNextGheInfo] = useState( - getRcGheInfo({ latestRelease, project, semverBumpLevel }), + const [nextGitHubInfo, setNextGitHubInfo] = useState( + getRcGitHubInfo({ latestRelease, project, semverBumpLevel }), ); useEffect(() => { - setNextGheInfo(getRcGheInfo({ latestRelease, project, semverBumpLevel })); - }, [semverBumpLevel, setNextGheInfo, latestRelease, project]); + setNextGitHubInfo( + getRcGitHubInfo({ latestRelease, project, semverBumpLevel }), + ); + }, [semverBumpLevel, setNextGitHubInfo, latestRelease, project]); - const [createReleaseResponse, callCreateGheRc] = useAsyncFn( - async (...args) => { - const createGheRcResponseSteps = await createGheRc({ + const [createGitHubReleaseResponse, createGitHubReleaseFn] = useAsyncFn( + (...args) => + createRc({ apiClient, defaultBranch, latestRelease, - nextGheInfo: args[0], + nextGitHubInfo: args[0], successCb, - }); - - return createGheRcResponseSteps; - }, + }), ); - - if (createReleaseResponse.error) { + if (createGitHubReleaseResponse.error) { return ( - {createReleaseResponse.error.message} + + {createGitHubReleaseResponse.error.message} + ); } const tagAlreadyExists = latestRelease !== null && - latestRelease.tag_name === nextGheInfo.rcReleaseTag; + latestRelease.tag_name === nextGitHubInfo.rcReleaseTag; const conflictingPreRelease = latestRelease !== null && latestRelease.prerelease; @@ -113,7 +113,7 @@ export const CreateRc = ({ return ( There's already a tag named{' '} - {nextGheInfo.rcReleaseTag} + {nextGitHubInfo.rcReleaseTag} ); } @@ -124,7 +124,7 @@ export const CreateRc = ({ @@ -132,7 +132,7 @@ export const CreateRc = ({ @@ -140,11 +140,14 @@ export const CreateRc = ({ } function CTA() { - if (createReleaseResponse.loading || createReleaseResponse.value) { + if ( + createGitHubReleaseResponse.loading || + createGitHubReleaseResponse.value + ) { return ( @@ -157,7 +160,7 @@ export const CreateRc = ({ disabled={conflictingPreRelease || tagAlreadyExists} variant="contained" color="primary" - onClick={() => callCreateGheRc(nextGheInfo)} + onClick={() => createGitHubReleaseFn(nextGitHubInfo)} > Create RC diff --git a/plugins/release-manager-as-a-service/src/cards/createRc/getRcGheInfo.test.ts b/plugins/release-manager-as-a-service/src/cards/createRc/getRcGitHubInfo.test.ts similarity index 84% rename from plugins/release-manager-as-a-service/src/cards/createRc/getRcGheInfo.test.ts rename to plugins/release-manager-as-a-service/src/cards/createRc/getRcGitHubInfo.test.ts index 0feb95734f..1ed3027f14 100644 --- a/plugins/release-manager-as-a-service/src/cards/createRc/getRcGheInfo.test.ts +++ b/plugins/release-manager-as-a-service/src/cards/createRc/getRcGitHubInfo.test.ts @@ -20,19 +20,19 @@ import { mockSemverProject, mockCalverProject, } from '../../test-helpers/test-helpers'; -import { getRcGheInfo } from './getRcGheInfo'; +import { getRcGitHubInfo } from './getRcGitHubInfo'; const injectedDate = format(1611869955783, 'yyyy.MM.dd'); -describe('getRCGheInfo', () => { +describe('getRcGitHubInfo', () => { describe('calver', () => { const latestRelease = { tag_name: 'rc-2020.01.01_0', } as GhGetReleaseResponse; - it('should return correct Ghe info', () => { + it('should return correct GitHub info', () => { expect( - getRcGheInfo({ + getRcGitHubInfo({ project: mockCalverProject, latestRelease, semverBumpLevel: 'minor', @@ -53,9 +53,9 @@ describe('getRCGheInfo', () => { tag_name: 'rc-1.1.1', } as GhGetReleaseResponse; - it("should return correct Ghe info when there's previous releases", () => { + it("should return correct GitHub info when there's previous releases", () => { expect( - getRcGheInfo({ + getRcGitHubInfo({ project: mockSemverProject, latestRelease, semverBumpLevel: 'minor', @@ -69,9 +69,9 @@ describe('getRCGheInfo', () => { `); }); - it("should return correct Ghe info when there's no previous release", () => { + it("should return correct GitHub info when there's no previous release", () => { expect( - getRcGheInfo({ + getRcGitHubInfo({ project: mockSemverProject, latestRelease: null, semverBumpLevel: 'minor', diff --git a/plugins/release-manager-as-a-service/src/cards/createRc/getRcGheInfo.ts b/plugins/release-manager-as-a-service/src/cards/createRc/getRcGitHubInfo.ts similarity index 98% rename from plugins/release-manager-as-a-service/src/cards/createRc/getRcGheInfo.ts rename to plugins/release-manager-as-a-service/src/cards/createRc/getRcGitHubInfo.ts index 6054117d9c..a35b46480e 100644 --- a/plugins/release-manager-as-a-service/src/cards/createRc/getRcGheInfo.ts +++ b/plugins/release-manager-as-a-service/src/cards/createRc/getRcGitHubInfo.ts @@ -20,7 +20,7 @@ import { getSemverTagParts } from '../../helpers/tagParts/getSemverTagParts'; import { Project, GhGetReleaseResponse } from '../../types/types'; import { SEMVER_PARTS } from '../../constants/constants'; -export const getRcGheInfo = ({ +export const getRcGitHubInfo = ({ project, latestRelease, semverBumpLevel, diff --git a/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createGheRc.test.ts b/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createRc.test.ts similarity index 92% rename from plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createGheRc.test.ts rename to plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createRc.test.ts index a94cd682ee..26450ac162 100644 --- a/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createGheRc.test.ts +++ b/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createRc.test.ts @@ -14,22 +14,22 @@ * limitations under the License. */ import { - mockDefaultBranch, - mockReleaseVersion, - mockNextGheInfo, mockApiClient, + mockDefaultBranch, + mockNextGitHubInfo, + mockReleaseVersion, } from '../../../test-helpers/test-helpers'; -import { createGheRc } from './createGheRc'; +import { createRc } from './createRc'; describe('createGheRc', () => { beforeEach(jest.clearAllMocks); it('should work', async () => { - const result = await createGheRc({ + const result = await createRc({ apiClient: mockApiClient, defaultBranch: mockDefaultBranch, latestRelease: mockReleaseVersion, - nextGheInfo: mockNextGheInfo, + nextGitHubInfo: mockNextGitHubInfo, }); expect(result).toMatchInlineSnapshot(` diff --git a/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createGheRc.ts b/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createRc.ts similarity index 85% rename from plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createGheRc.ts rename to plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createRc.ts index 29491fb13e..2b5b71ee24 100644 --- a/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createGheRc.ts +++ b/plugins/release-manager-as-a-service/src/cards/createRc/sideEffects/createRc.ts @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { getRcGheInfo } from '../getRcGheInfo'; +import { getRcGitHubInfo } from '../getRcGitHubInfo'; import { ComponentConfigCreateRc, GhCreateReferenceResponse, @@ -24,21 +24,21 @@ import { import { RMaaSApiClient } from '../../../api/RMaaSApiClient'; import { ReleaseManagerAsAServiceError } from '../../../errors/ReleaseManagerAsAServiceError'; -interface CreateGheRC { +interface CreateRC { apiClient: RMaaSApiClient; defaultBranch: GhGetRepositoryResponse['default_branch']; latestRelease: GhGetReleaseResponse | null; - nextGheInfo: ReturnType; + nextGitHubInfo: ReturnType; successCb?: ComponentConfigCreateRc['successCb']; } -export async function createGheRc({ +export async function createRc({ apiClient, defaultBranch, latestRelease, - nextGheInfo, + nextGitHubInfo, successCb, -}: CreateGheRC) { +}: CreateRC) { const responseSteps: ResponseStep[] = []; /** @@ -62,13 +62,13 @@ export async function createGheRc({ createdRef = ( await apiClient.createRc.createRef({ mostRecentSha, - targetBranch: nextGheInfo.rcBranch, + targetBranch: nextGitHubInfo.rcBranch, }) ).createdRef; } catch (error) { if (error.body.message === 'Reference already exists') { throw new ReleaseManagerAsAServiceError( - `Branch "${nextGheInfo.rcBranch}" already exists: .../tree/${nextGheInfo.rcBranch}`, + `Branch "${nextGitHubInfo.rcBranch}" already exists: .../tree/${nextGitHubInfo.rcBranch}`, ); } throw error; @@ -84,7 +84,7 @@ export async function createGheRc({ const previousReleaseBranch = latestRelease ? latestRelease.target_commitish : defaultBranch; - const nextReleaseBranch = nextGheInfo.rcBranch; + const nextReleaseBranch = nextGitHubInfo.rcBranch; const { comparison } = await apiClient.createRc.getComparison({ previousReleaseBranch, nextReleaseBranch, @@ -105,15 +105,15 @@ export async function createGheRc({ }); /** - * 4. Creates the release itself in GHE + * 4. Creates the release itself in GitHub */ const { createReleaseResponse } = await apiClient.createRc.createRelease({ - nextGheInfo, + nextGitHubInfo: nextGitHubInfo, releaseBody, }); responseSteps.push({ message: `Created Release Candidate "${createReleaseResponse.name}"`, - secondaryMessage: `with tag "${nextGheInfo.rcReleaseTag}"`, + secondaryMessage: `with tag "${nextGitHubInfo.rcReleaseTag}"`, link: createReleaseResponse.html_url, }); diff --git a/plugins/release-manager-as-a-service/src/cards/info/Info.tsx b/plugins/release-manager-as-a-service/src/cards/info/Info.tsx index 3d27e24297..76d821b0a5 100644 --- a/plugins/release-manager-as-a-service/src/cards/info/Info.tsx +++ b/plugins/release-manager-as-a-service/src/cards/info/Info.tsx @@ -25,7 +25,7 @@ import { } from '../../types/types'; import { useStyles } from '../../styles/styles'; import { TEST_IDS } from '../../test-helpers/test-ids'; -import rmaasFlowImage from './rmaas-flow.png'; +import flowImage from './flow.png'; interface InfoCardProps { releaseBranch: GhGetBranchResponse | null; @@ -46,26 +46,26 @@ export const Info = ({ Terminology - GitHub Enterprise (GHE): The source control system - where releases reside in a practical sense. Read more about GitHub - releases{' '} + GitHub: The source control system where releases + reside in a practical sense. Read more about GitHub releases{' '} here - . Note that this plugin works just as well with a non-enterprise - account. + . Note that this plugin works just as well with GitHub Enterprise + (GHE) - Release Candidate: A GHE pre-release intended - primarily for internal testing + Release Candidate: A GitHub prerelease{' '} + intended primarily for internal testing - Release Version: A GHE release intended for end users + Release Version: A GitHub release intended for end + users @@ -82,7 +82,7 @@ export const Info = ({ Here's an overview of the flow: - rmaas-flow + flow
@@ -91,7 +91,7 @@ export const Info = ({ Repository:{' '} diff --git a/plugins/release-manager-as-a-service/src/cards/info/rmaas-flow.png b/plugins/release-manager-as-a-service/src/cards/info/flow.png similarity index 100% rename from plugins/release-manager-as-a-service/src/cards/info/rmaas-flow.png rename to plugins/release-manager-as-a-service/src/cards/info/flow.png diff --git a/plugins/release-manager-as-a-service/src/cards/patchRc/PatchBody.tsx b/plugins/release-manager-as-a-service/src/cards/patchRc/PatchBody.tsx index a30515c9b6..6d15bc6a08 100644 --- a/plugins/release-manager-as-a-service/src/cards/patchRc/PatchBody.tsx +++ b/plugins/release-manager-as-a-service/src/cards/patchRc/PatchBody.tsx @@ -69,7 +69,7 @@ export const PatchBody = ({ const apiClient = useApiClientContext(); const [checkedCommitIndex, setCheckedCommitIndex] = useState(-1); - const gheDataResponse = useAsync(async () => { + const githubDataResponse = useAsync(async () => { const [ { branch: releaseBranchResponse }, { recentCommits }, @@ -91,7 +91,7 @@ export const PatchBody = ({ }; }); - const [patchGheRcResponse, patchGheRcFn] = useAsyncFn(async (...args) => { + const [patchReleaseResponse, patchReleaseFn] = useAsyncFn(async (...args) => { const selectedPatchCommit: GhGetCommitResponse = args[0]; const patchResponseSteps = await patch({ apiClient, @@ -105,17 +105,17 @@ export const PatchBody = ({ return patchResponseSteps; }); - if (gheDataResponse.error) { + if (githubDataResponse.error) { return ( - {gheDataResponse.error.message} + {githubDataResponse.error.message} ); } - if (patchGheRcResponse.error) { - return {patchGheRcResponse.error.message}; + if (patchReleaseResponse.error) { + return {patchReleaseResponse.error.message}; } - if (gheDataResponse.loading) { + if (githubDataResponse.loading) { return ; } @@ -131,7 +131,7 @@ export const PatchBody = ({ severity="info" > - The current GHE release is a Release Version + The current GitHub release is a Release Version It's still possible to patch it, but be extra mindful of changes @@ -145,14 +145,14 @@ export const PatchBody = ({ } function CommitList() { - if (!gheDataResponse.value?.recentCommits) { + if (!githubDataResponse.value?.recentCommits) { return null; } return ( - {gheDataResponse.value.recentCommits.map((commit, index) => { - const commitExistsOnReleaseBranch = !!gheDataResponse.value?.recentReleaseBranchCommits.find( + {githubDataResponse.value.recentCommits.map((commit, index) => { + const commitExistsOnReleaseBranch = !!githubDataResponse.value?.recentReleaseBranchCommits.find( ({ sha }) => { return sha === commit.sha; }, @@ -185,9 +185,9 @@ export const PatchBody = ({ 0) || + patchReleaseResponse.loading || + (patchReleaseResponse.value && + patchReleaseResponse.value.length > 0) || commitExistsOnReleaseBranch } role={undefined} @@ -252,11 +252,11 @@ export const PatchBody = ({ } function CTA() { - if (patchGheRcResponse.loading || patchGheRcResponse.value) { + if (patchReleaseResponse.loading || patchReleaseResponse.value) { return ( Patch Release Candidate @@ -279,8 +279,8 @@ export const PatchBody = ({ color="primary" onClick={() => { // FIXME: Optional chaining shouldn't be needed here due to the if-statement above - patchGheRcFn( - gheDataResponse.value?.recentCommits[checkedCommitIndex], + patchReleaseFn( + githubDataResponse.value?.recentCommits[checkedCommitIndex], ); }} > diff --git a/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRc.tsx b/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRc.tsx index a591f71cd1..e7583e7085 100644 --- a/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRc.tsx +++ b/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRc.tsx @@ -53,7 +53,9 @@ export const PromoteRc = ({ className={classes.paragraph} severity="warning" > - Latest GHE release is not a Release Candidate + + Latest GitHub release is not a Release Candidate + One can only promote Release Candidates to Release Versions ); diff --git a/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRcBody.tsx b/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRcBody.tsx index 31eb883dee..99ca136fac 100644 --- a/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRcBody.tsx +++ b/plugins/release-manager-as-a-service/src/cards/promoteRc/PromoteRcBody.tsx @@ -24,7 +24,7 @@ import { GhGetReleaseResponse, SetRefetch, } from '../../types/types'; -import { promoteGheRc } from './sideEffects/promoteGheRc'; +import { promoteRc } from './sideEffects/promoteRc'; import { ResponseStepList } from '../../components/ResponseStepList/ResponseStepList'; import { useApiClientContext } from '../../components/ProjectContext'; import { useStyles } from '../../styles/styles'; @@ -44,12 +44,14 @@ export const PromoteRcBody = ({ const apiClient = useApiClientContext(); const classes = useStyles(); const releaseVersion = rcRelease.tag_name.replace('rc-', 'version-'); - const [promoteGheRcResponse, promoseGheRcFn] = useAsyncFn( - promoteGheRc({ apiClient, rcRelease, releaseVersion, successCb }), + const [promoteGitHubRcResponse, promoseGitHubRcFn] = useAsyncFn( + promoteRc({ apiClient, rcRelease, releaseVersion, successCb }), ); - if (promoteGheRcResponse.error) { - return {promoteGheRcResponse.error.message}; + if (promoteGitHubRcResponse.error) { + return ( + {promoteGitHubRcResponse.error.message} + ); } function Description() { @@ -67,13 +69,13 @@ export const PromoteRcBody = ({ } function CTA() { - if (promoteGheRcResponse.loading || promoteGheRcResponse.value) { + if (promoteGitHubRcResponse.loading || promoteGitHubRcResponse.value) { return ( ); } @@ -83,7 +85,7 @@ export const PromoteRcBody = ({ data-testid={TEST_IDS.promoteRc.cta} variant="contained" color="primary" - onClick={() => promoseGheRcFn()} + onClick={() => promoseGitHubRcFn()} > Promote Release Candidate diff --git a/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteGheRc.test.ts b/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteRc.test.ts similarity index 90% rename from plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteGheRc.test.ts rename to plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteRc.test.ts index d6df61a1f3..a64cf70f81 100644 --- a/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteGheRc.test.ts +++ b/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteRc.test.ts @@ -17,13 +17,13 @@ import { mockRcRelease, mockApiClient, } from '../../../test-helpers/test-helpers'; -import { promoteGheRc } from './promoteGheRc'; +import { promoteRc } from './promoteRc'; -describe('promoteGheRc', () => { +describe('promoteRc', () => { beforeEach(jest.clearAllMocks); it('should work', async () => { - const result = await promoteGheRc({ + const result = await promoteRc({ apiClient: mockApiClient, rcRelease: mockRcRelease, releaseVersion: 'version-1.2.3', diff --git a/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteGheRc.ts b/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteRc.ts similarity index 95% rename from plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteGheRc.ts rename to plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteRc.ts index 91371b72a6..d473951a91 100644 --- a/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteGheRc.ts +++ b/plugins/release-manager-as-a-service/src/cards/promoteRc/sideEffects/promoteRc.ts @@ -20,19 +20,19 @@ import { } from '../../../types/types'; import { RMaaSApiClient } from '../../../api/RMaaSApiClient'; -interface PromoteGheRc { +interface PromoteRc { apiClient: RMaaSApiClient; rcRelease: GhGetReleaseResponse; releaseVersion: string; successCb?: ComponentConfigPromoteRc['successCb']; } -export function promoteGheRc({ +export function promoteRc({ apiClient, rcRelease, releaseVersion, successCb, -}: PromoteGheRc) { +}: PromoteRc) { return async (): Promise => { const responseSteps: ResponseStep[] = []; diff --git a/plugins/release-manager-as-a-service/src/components/Differ.tsx b/plugins/release-manager-as-a-service/src/components/Differ.tsx index 7af998792b..02bf60ce46 100644 --- a/plugins/release-manager-as-a-service/src/components/Differ.tsx +++ b/plugins/release-manager-as-a-service/src/components/Differ.tsx @@ -25,7 +25,7 @@ interface DifferProps { next?: string | ReactNode; prev?: string; prefix?: string; - icon?: 'tag' | 'branch' | 'ghe' | 'slack' | 'versioning'; + icon?: 'tag' | 'branch' | 'github' | 'slack' | 'versioning'; } const Icon = ({ icon }: { icon: DifferProps['icon'] }) => { @@ -40,7 +40,7 @@ const Icon = ({ icon }: { icon: DifferProps['icon'] }) => { ); - case 'ghe': + case 'github': return ( ); diff --git a/plugins/release-manager-as-a-service/src/components/NoLatestRelease.tsx b/plugins/release-manager-as-a-service/src/components/NoLatestRelease.tsx index 85909d526d..f09049f3cf 100644 --- a/plugins/release-manager-as-a-service/src/components/NoLatestRelease.tsx +++ b/plugins/release-manager-as-a-service/src/components/NoLatestRelease.tsx @@ -28,7 +28,7 @@ export const NoLatestRelease = () => { className={classes.paragraph} severity="warning" > - Unable to find any GHE releases + Unable to find any GitHub release ); }; diff --git a/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.test.ts b/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.test.ts index e72eba4df4..78c48eb0a7 100644 --- a/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.test.ts +++ b/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.test.ts @@ -73,7 +73,7 @@ describe('testHelpers', () => { "versioningStrategy": "calver", }, "mockDefaultBranch": "mock_defaultBranch", - "mockNextGheInfo": Object { + "mockNextGitHubInfo": Object { "rcBranch": "rc/1.2.3", "rcReleaseTag": "rc-1.2.3", "releaseName": "Version 1.2.3", diff --git a/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.ts b/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.ts index b994e591d2..61d8cb3b17 100644 --- a/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.ts +++ b/plugins/release-manager-as-a-service/src/test-helpers/test-helpers.ts @@ -14,7 +14,7 @@ * limitations under the License. */ import { CalverTagParts } from '../helpers/tagParts/getCalverTagParts'; -import { getRcGheInfo } from '../cards/createRc/getRcGheInfo'; +import { getRcGitHubInfo } from '../cards/createRc/getRcGitHubInfo'; import { GhCompareCommitsResponse, GhCreateCommitResponse, @@ -50,7 +50,7 @@ export const mockCalverProject: Project = { export const mockDefaultBranch = 'mock_defaultBranch'; -export const mockNextGheInfo: ReturnType = { +export const mockNextGitHubInfo: ReturnType = { rcBranch: 'rc/1.2.3', rcReleaseTag: 'rc-1.2.3', releaseName: 'Version 1.2.3',