feat(GHA): workflow file creation onboarding #577

kanadgupta · 2022-08-22T22:32:11Z

🚥 Fix RM-5048

🧰 Changes

The Linear ticket has all the details on what we're trying to do here!

Must Haves:

Nice to haves:

Validation of the GitHub workflows using the JSON Schema definition

🧬 QA & Testing

I've added a metric ton of tests for all of this, but I think once this is merged, we should play around with it in a beta release just to make sure it functions as expected.

If you'd like to play around with this work yourself, check out this branch and run the following commands:

# Install and set up the build
npm ci && npm run build

# You can use this command and select a valid file from the prompt, like ` __tests__/__fixtures__/petstore-simple-weird-version.json`
bin/rdme validate

# Alternatively, you can just pass the `github` flag which will run the GHA creation flow every time:
bin/rdme validate --github

# Alternatively, you can just pass the file directly into the command:
bin/rdme validate __tests__/__fixtures__/petstore-simple-weird-version.json

I used validate above since that one is the quickest to test (i.e. doesn't require auth), but you can also test any of the following commands as well:

openapi
docs
docs:single
changelogs
changelogs:single
custompages
custompages:single

If you follow the prompts, you'll end up with a brand-spankin'-new GitHub Actions workflow file that contains that command 🪄

changelogs, custompages, etc... it's fairly easy to add new commands! I'll probably just write E2E tests for the docs command since the other ones are just super lightweight wrappers around the docs logic ↩ ↩²
(this seems like it could be very prone to breakage... not gonna do it but I'll list it here for posterity) ↩

doing this so we can preserve the `this` scope

…ating

after thinking about it some more, this doesn't feel necessary since we can just grab it from the current package. it also might cause issues if we create a broken workflow file due to breaking changes. instead we should add a dependabot config.

i like this way just in case the opts string is empty (which is unlikely but w/e)

not sure why these are failing 🤔

Tests were failing because we had defined our regex expressions globally

this will be a lot faster when writing tests for other suites

this way we can mock out our package version easily and we don't need to update our snapshots every time we bump our package version 😬

erunion

__tests__/cmds/openapi/reduce.test.ts

__tests__/lib/createGHA.test.ts

src/cmds/changelogs/index.ts

src/lib/createGHA/baseFile.ts

…ating

#577 (comment)

Feedback: #577 (comment)

Feedback: #577 (comment) Co-Authored-By: Jon Ursenbach <[email protected]>

…ating

unfortunately this isn't exactly where we want it to be—we still have to manually add the `--github` arg to the command definitions. also adding some tests for this new functionality. feedback: #577 (comment) Co-Authored-By: Jon Ursenbach <[email protected]>

kanadgupta · 2022-09-06T21:36:42Z

src/cmds/custompages/index.ts

@@ -12,6 +13,7 @@ export type Options = {
  folder?: string;
 };

+@supportsGHA


The diffs in these files are way cleaner now @erunion :chefs-kiss:

erunion

I'm happy with this! Would love to encapsulate the getGithubArg stuff into the decorator at some point (because we can probably do a @authRequired one too) but I don't think it's worth the --help refactor it's going to require right now.

__tests__/cmds/docs/index.test.ts

erunion · 2022-09-06T21:51:12Z

__tests__/lib/createGHA.test.ts

+        CmdClass: SingleCustomPageCommand,
+        opts: { key, filePath: './custompages/rdme.md' },
+      },
+    ])('$cmd', ({ cmd, CmdClass, opts }) => {


Oh neat I didn't know you could do $cmd like this.

yeah i also learned about this today 😌

also removed the unnecessary boolean return value since it's a void function

kanadgupta added 30 commits August 22, 2022 11:24

fix: make command type more specific

63a955f

refactor: consolidate key opt definition

2b732b8

fix: stricter type definition

072d8fc

chore: small copy change

9fb264b

refactor: small function change

0ebda16

doing this so we can preserve the `this` scope

fix: lint

1c5f333

feat: first pass at GHA generation

81db4ae

feat: add --github flag

787f1cc

fix: allow user to not pass in spec path

464ff94

chore: small copy change

60abfab

fix: cleaning up a type, adding a smol doc

45b8569

test: add coverage for if user says no

41b3754

refactor: new function signature, better typings

33c46b5

Merge branch 'main' into kanad/rm-5048-add-prompt-flow-to-cli-for-cre…

bbb21e0

…ating

test: smol refactor

8696f0e

test: remove unused mock

21dadf8

fix: better type

bb4c5d8

fix: remove unused async

a70d917

refactor: remove github API fetch

aa649ef

after thinking about it some more, this doesn't feel necessary since we can just grab it from the current package. it also might cause issues if we create a broken workflow file due to breaking changes. instead we should add a dependabot config.

refactor: better command string construction

fa4a8be

i like this way just in case the opts string is empty (which is unlikely but w/e)

chore: some base file copy updates

95bff68

refactor: make isGitHub file more generic

86d4d87

refactor: consolidate CI checks into shared function

feb7434

feat: prevent user from running --github in CI env

59720aa

feat: first pass at git detection

dee97b9

test: add some test cases

0e0a621

not sure why these are failing 🤔

chore: skip failing tests to see if CI passes

9cbc5d9

fix: move regex to inside function

b3e2a6e

Tests were failing because we had defined our regex expressions globally

test:: smol refactor

d28d780

test: refactor to describe.each()

a5fce90

this will be a lot faster when writing tests for other suites

kanadgupta added 7 commits August 30, 2022 14:20

feat: do major version check for configstore

64db3c5

fix: separate out package version retrieval into function

01cf659

this way we can mock out our package version easily and we don't need to update our snapshots every time we bump our package version 😬

chore: error message language

70e950c

docs: github **actions** workflow, not github action (singular)

7ba3dfc

docs: better intro language

19bf47e

docs: better success language

ab39f20

chore: fix snapshot, de-localize docs link

442767c

kanadgupta marked this pull request as ready for review August 30, 2022 23:52

chore: smol language update per Spang

7d1610c

erunion reviewed Sep 2, 2022

View reviewed changes

kanadgupta mentioned this pull request Sep 6, 2022

feat(openapi): Update oas file based on title #586

Closed

kanadgupta and others added 9 commits September 6, 2022 09:40

Merge branch 'main' into kanad/rm-5048-add-prompt-flow-to-cli-for-cre…

3d08179

…ating

test: don't fetch schema from URL

f88459f

#577 (comment)

test: update broken test

c53ed7b

test(GHA): extract setup/teardowns into common lib

0f956f9

Feedback: #577 (comment)

test: better describe.each signature

050424d

Feedback: #577 (comment) Co-Authored-By: Jon Ursenbach <[email protected]>

Merge branch 'main' into kanad/rm-5048-add-prompt-flow-to-cli-for-cre…

f348c95

…ating

chore: debug statements

8bbc896

fix: weird flaky TS error

aee7b04

refactor: use decorator

4188332

unfortunately this isn't exactly where we want it to be—we still have to manually add the `--github` arg to the command definitions. also adding some tests for this new functionality. feedback: #577 (comment) Co-Authored-By: Jon Ursenbach <[email protected]>

kanadgupta commented Sep 6, 2022

View reviewed changes

kanadgupta requested a review from erunion September 6, 2022 21:37

erunion approved these changes Sep 6, 2022

View reviewed changes

chore(mock/fs): clearer var names

a72f9ae

also removed the unnecessary boolean return value since it's a void function

kanadgupta merged commit 9ee808e into main Sep 6, 2022

kanadgupta deleted the kanad/rm-5048-add-prompt-flow-to-cli-for-creating branch September 6, 2022 22:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(GHA): workflow file creation onboarding #577

feat(GHA): workflow file creation onboarding #577

kanadgupta commented Aug 22, 2022 •

edited

Loading

erunion left a comment

kanadgupta Sep 6, 2022

erunion left a comment

erunion Sep 6, 2022

kanadgupta Sep 6, 2022

feat(GHA): workflow file creation onboarding #577

feat(GHA): workflow file creation onboarding #577

Conversation

kanadgupta commented Aug 22, 2022 • edited Loading

🧰 Changes

Must Haves:

Nice to haves:

Archive

🧬 QA & Testing

Footnotes

erunion left a comment

Choose a reason for hiding this comment

kanadgupta Sep 6, 2022

Choose a reason for hiding this comment

erunion left a comment

Choose a reason for hiding this comment

erunion Sep 6, 2022

Choose a reason for hiding this comment

kanadgupta Sep 6, 2022

Choose a reason for hiding this comment

kanadgupta commented Aug 22, 2022 •

edited

Loading