Skip to content

Add github action for CI (lint, check format, build)#53

Merged
lyonsil merged 5 commits intoparanext:mainfrom
jasonleenaylor:add-linting-action
Jun 11, 2025
Merged

Add github action for CI (lint, check format, build)#53
lyonsil merged 5 commits intoparanext:mainfrom
jasonleenaylor:add-linting-action

Conversation

@jasonleenaylor
Copy link
Copy Markdown
Contributor

@jasonleenaylor jasonleenaylor commented Jun 11, 2025

  • Also clean-up some README.md markdown best practice violations

This change is Reviewable

* Also clean-up some README.md markdown best practice violations
Copy link
Copy Markdown
Member

@lyonsil lyonsil left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I have one thing in the GH workflow file, and the rest looks great.

Reviewed 1 of 2 files at r1, 1 of 2 files at r2, 2 of 2 files at r3, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @jasonleenaylor)


.github/workflows/build.yml line 36 at r3 (raw file):
build doesn't actually do anything in the template. It's kind of confusing that it's here in this workflow, and the output from the job just says:

Run npm run build

> paranext-multi-extension-template@0.0.1 build
> webpack

No extensions found! Please run `npm run create-extension -- <extension-name>` (kebab-case) to create an extension. See README.md for more information.

What are you trying to catch with this step? It might be a little clearer to:

  • remove this build step
  • change the job name from "lint-and-build" to "lint"
  • change this GH workflow file from "build.yml" to "lint.yml"
  • change the OS matrix to only be ubuntu-latest since linting doesn't vary by OS

@jasonleenaylor
Copy link
Copy Markdown
Contributor Author

.github/workflows/build.yml line 36 at r3 (raw file):

Previously, lyonsil (Matt Lyons) wrote…

build doesn't actually do anything in the template. It's kind of confusing that it's here in this workflow, and the output from the job just says:

Run npm run build

> paranext-multi-extension-template@0.0.1 build
> webpack

No extensions found! Please run `npm run create-extension -- <extension-name>` (kebab-case) to create an extension. See README.md for more information.

What are you trying to catch with this step? It might be a little clearer to:

  • remove this build step
  • change the job name from "lint-and-build" to "lint"
  • change this GH workflow file from "build.yml" to "lint.yml"
  • change the OS matrix to only be ubuntu-latest since linting doesn't vary by OS

Ah yeah, I originally was going to have it call create-extension and build but I thought that was overkill. Should have thought through what build actually did without that. 🤦‍♂️

Copy link
Copy Markdown
Member

@lyonsil lyonsil left a comment

Choose a reason for hiding this comment

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

:lgtm: Please make sure to squash this when merging.

Reviewed 1 of 1 files at r4, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @jasonleenaylor)


.github/workflows/build.yml line 36 at r3 (raw file):

Previously, jasonleenaylor (Jason Naylor) wrote…

Ah yeah, I originally was going to have it call create-extension and build but I thought that was overkill. Should have thought through what build actually did without that. 🤦‍♂️

Thanks for the update!

Copy link
Copy Markdown
Member

@lyonsil lyonsil left a comment

Choose a reason for hiding this comment

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

Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @jasonleenaylor)

Copy link
Copy Markdown
Member

@tjcouch-sil tjcouch-sil left a comment

Choose a reason for hiding this comment

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

:lgtm: Jason, would you be interested in duplicating this on the paranext-extension-template repo as well? Or shall someone else plan to do that? Thanks for this good stuff!

Reviewed 1 of 2 files at r1, 1 of 2 files at r2, 1 of 2 files at r3, 1 of 1 files at r4, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @jasonleenaylor)

@lyonsil lyonsil merged commit 31034e5 into paranext:main Jun 11, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants