Convert to TS project #81

spenserblack · 2023-05-22T13:32:09Z

Closes #80

codecov · 2023-05-22T13:40:01Z

Codecov Report

❗ No coverage uploaded for pull request base (main@d1c7c54). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             main       #81   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         2           
  Lines           ?        31           
  Branches        ?         3           
========================================
  Hits            ?        31           
  Misses          ?         0           
  Partials        ?         0

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

jcbhmr · 2023-05-23T19:54:22Z

If you don't want to do the song and dance to validate the committed dist/ folder, you can use something that automagically does it for you on release tags!

https://github.com/JasonEtco/build-and-tag-action

name: Publish

on:
  release:
    types: [published, edited]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          ref: ${{ github.event.release.tag_name }}
      - name: Install deps and build
        run: npm ci && npm run build
      - uses: JasonEtco/build-and-tag-action@v2
        env:
          GITHUB_TOKEN: ${{ github.token }}

The guide to JavaScript Actions recommends including node_modules in your repository, and manual steps to following the versioning recommendations. There are anti-patterns there that just don't sit right with me; so we can enable the same workflow, automatically!

I haven't used it (I haven't made a JS action myself) but it seems interesting!

spenserblack · 2023-05-23T20:06:14Z

I'm checking that dist/ is built on every PR/push so that users can use @main for the most up-to-date version. And I could generate a commit for every push to main, but I'd rather have everything bundled in a single commit 🙂
Right now it's not too much trouble, but maybe I'll add a workflow specific to PRs to help out contributors that forget this step.

spenserblack · 2023-05-24T19:52:26Z

@jcbhmr FYI if you want to test this action before I merge this rewrite. I don't really have time to test it out right now.

spenserblack · 2023-05-24T19:57:35Z

BTW feel free to make PRs targeting the 80/rewrite branch if you have any ideas prior to merge.

jcbhmr · 2023-05-28T00:17:23Z

.devcontainer/devcontainer.json

    }
  },
-  // https://webinstall.dev/
-  "postCreateCommand": "curl -sS https://webi.sh/shfmt | sh && curl -sS https://webi.sh/shellcheck | sh"
+  "postCreateCommand": ".devcontainer/postCreate.sh",


- "postCreateCommand": ".devcontainer/postCreate.sh", + "postCreateCommand": "pnpm install",

It is just one command after all 😂

Just a bit of future-proofing for when more post-create commands need to be added. Plus, it's a cheat to add a bit more language diversity to this project 😉

jcbhmr · 2023-05-28T00:24:51Z

src/index.ts

Did you want to port https://github.com/Andrew-Chen-Wang/github-wiki-action/blob/master/src/clone.sh or https://github.com/spenserblack/actions-wiki/blob/main/src/index.sh ? 🤔

I (personally since I wrote it 😁) think that the idea of using gh repo clone into a tmp folder and using $GIT_DIR and $GIT_WORK_TREE is better than trying to finagle the git clone into the working tree.

Pros of gh repo clone user/repo.wiki /tmp/123abc:

You don't deal with #72

You don't need to worry about the .git folder in the $PWD subtree affecting anything else (git submodule weirdness detection)

You can clone the remote repo directly instead of git init and fetch

Remember I am biased. 😜

Right now this PR is an attempt to translate to a different language without much change to the implementation. This is partly my obsession with "clean" git histories, but I'd want this rewrite to have few to no significant side effects. But I'm definitely open to changing the implementation after this PR 🙂

jcbhmr · 2023-05-28T00:26:45Z

src/index.ts

@@ -0,0 +1,76 @@
+import * as core from "@actions/core";
+import { exec } from "@actions/exec";


Cool 😎 library that makes it much easier to do shell stuff: https://github.com/google/zx#readme
You don't have to use it, I'm just letting you know this cool thing exists 😊

I never bothered researching this, but I've always wondered why @actions/exec exists when there are already other popular implementations for calling commands (another one is execa). Like, is there something about @actions/exec that optimizes it for actions? All I've found is actions/toolkit#315

jcbhmr · 2023-05-28T00:31:05Z

package.json

+  "main": "lib/index.js",
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write .",


- "format": "prettier --write .", + "format": "prettier --ignore-path .gitignore -w .",

This would make it so you don't need a .prettierignore since your .gitignore would double as your .prettier ignore.
Though then again this might conflict with the fact that there's minified JS in dist/ in source control 🤦‍♀️

Yeah, prettifying built files is an annoyance that I'd like to avoid.

jcbhmr · 2023-05-28T00:33:32Z

.gitignore

I like to use https://github.com/github/gitignore/blob/main/Node.gitignore since it's "official" but that's just me 😊

Yeah, besides the fact that it ignores dist/ by default AFAIK, there's no reason I'm not using it besides being to lazy to fetch that file 😆

jcbhmr · 2023-05-28T00:36:23Z

src/has-wiki.ts

I think the default gh repo clone octocat/project.wiki has a good enough error message, right? 🤔

$ gh repo clone nodejs/node.wiki The 'nodejs/node' repository does not have a wiki

I think just letting that gh repo clone command fail and print its own error message is OK. 🤷‍♀️

TIL that gh has an explicit check if you're cloning a wiki 😆

While gh is an awesome tool, one of the things I want to do is drop dependency on gh and implement as much with pure TS as possible.

jcbhmr · 2023-05-28T00:38:15Z

src/index.ts

+  const baseOptions = { cwd };
+  await exec("git", ["init"], baseOptions);


Remember! This still has the issue with the existing .git folder from the main repo that was actions/checkout-ed into here! #72

Yup! This will be addressed in a subsequent change.

jcbhmr · 2023-05-28T00:48:02Z

Just noticed that the test.yml file was removed 😬 I highly recommend that that e2e test stays in there! It's arguably the most important test of all and has saved me a couple of times. https://github.com/spenserblack/actions-wiki/actions/workflows/test.yml

Convert to TS project

0d45671

spenserblack linked an issue May 22, 2023 that may be closed by this pull request

Rewrite in TS/JS #80

Closed

spenserblack added 3 commits May 22, 2023 09:36

Install pnpm in workflows

1ddf419

fixup! Install pnpm in workflows

109304e

fixup! Install pnpm in workflows

55840c2

spenserblack added 8 commits May 22, 2023 09:40

Fix prettier config

77821de

Ignore coverage when formatting

7f8b8b9

Ignore pnpm lock

3825340

Format

eebbaef

Reformat Markdown

3f3e322

Set devcontainer for TS project

6b09b42

Rebuild

ec2574e

Use node 16

a40a545

jcbhmr mentioned this pull request May 24, 2023

Change default folder to wiki #57

Closed

5 tasks

spenserblack added 4 commits May 24, 2023 16:09

Add function to check for wiki presence

ae6cbb7

Add function to check if repo has changes

0686ff0

Rewrite main script as TS action

eee9971

Format

41d719c

spenserblack marked this pull request as ready for review May 24, 2023 19:52

jcbhmr approved these changes May 28, 2023

View reviewed changes

spenserblack added 2 commits May 28, 2023 17:30

Add back e2e/dogfood test

e8ff08f

Format

dd9a10d

spenserblack merged commit 7f81269 into main May 28, 2023

spenserblack deleted the 80/rewrite branch May 28, 2023 17:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert to TS project #81

Convert to TS project #81

spenserblack commented May 22, 2023

codecov bot commented May 22, 2023 •

edited

Loading

jcbhmr commented May 23, 2023 •

edited

Loading

spenserblack commented May 23, 2023

spenserblack commented May 24, 2023

spenserblack commented May 24, 2023

jcbhmr May 28, 2023 •

edited

Loading

spenserblack May 28, 2023

jcbhmr May 28, 2023

jcbhmr May 28, 2023

spenserblack May 28, 2023

jcbhmr May 28, 2023

spenserblack May 28, 2023

jcbhmr May 28, 2023

spenserblack May 28, 2023

jcbhmr May 28, 2023

spenserblack May 28, 2023

jcbhmr May 28, 2023

spenserblack May 28, 2023

jcbhmr May 28, 2023

spenserblack May 28, 2023

jcbhmr commented May 28, 2023

		@@ -0,0 +1,76 @@
		import * as core from "@actions/core";
		import { exec } from "@actions/exec";

		const baseOptions = { cwd };
		await exec("git", ["init"], baseOptions);

Convert to TS project #81

Convert to TS project #81

Conversation

spenserblack commented May 22, 2023

codecov bot commented May 22, 2023 • edited Loading

Codecov Report

jcbhmr commented May 23, 2023 • edited Loading

spenserblack commented May 23, 2023

spenserblack commented May 24, 2023

spenserblack commented May 24, 2023

jcbhmr May 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcbhmr commented May 28, 2023

codecov bot commented May 22, 2023 •

edited

Loading

jcbhmr commented May 23, 2023 •

edited

Loading

jcbhmr May 28, 2023 •

edited

Loading