Skip to content

Conversation

@alukach
Copy link
Member

@alukach alukach commented Nov 24, 2020

This PR:

  1. Adds CI support (closes Setup CI #3):
    1. runs tests
    2. builds the project
    3. generates documentation on every push
    4. (on pushes to main) deploys the Jekyll documentation to the gh-pages branch
  2. Finalizes _config.yaml
  3. Adds github logo to github link
  4. Removes development helper comments
@alukach alukach requested a review from botanical November 24, 2020 05:54
@alukach alukach requested a review from markdboyd November 24, 2020 06:27
@alukach alukach changed the title Gh pages support CI Integration Nov 24, 2020
Copy link
Contributor

@markdboyd markdboyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I have one very small requested change

- name: Setup node.js 🏡
uses: actions/setup-node@v1
with:
node-version: '14.15.0'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're going to test against Node 14.15, let's add an .nvmrc to use that locally

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This value actually came from our .nvmrc (that you added in b3613d1 😉 )

14.15.0

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well then, touché

@@ -0,0 +1,5 @@
"use strict";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test files in TS? Oh my

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💥

We don't actually need to do this, however I find the imports and type-completion to be a bit simpler.

Comment on lines +28 to +32
- name: Test 🧪
run: |
npm test

- name: Build 🏗️
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to build before we test because we're testing against the TS directly?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, this PR adds a transform to Jest that allows Jest to do the translating on the fly.

cdk-seed/package.json

Lines 28 to 31 in 0b21151

"jest": {
"transform": {
"^.+\\.tsx?$": "ts-jest"
},

@alukach alukach merged commit f223dea into main Nov 24, 2020
@alukach alukach deleted the gh-pages-support branch November 24, 2020 18:37
alukach added a commit that referenced this pull request Nov 24, 2020
* Update for gh-pages integration * Add GH Actions script * Test jekyll-action * Let jekyll-action build * Tmp rm target_branch * Up version * Update Gemfile.lock * Update PAT, set target branc * Only deploy on merges to main * Rm comments and persist-credentials option * Add cache * Add quores * Avoid collections for simplicity * Rm build command * Cleanup * Revert to docs path rather than construct dir * Add test step, use granular steps * Add emoji * Fix import? * Fix name * TS based testing * Add TS dependency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants