Feat/add pkgjs workflow

[radomird]

I've updated the ci workflow to use https://github.com/pkgjs/action.
Few notes:
- the action is not released yet and thus it's using the @main version
- the "link" to the action is pkgjs/action/.github/workflows/node-test.yaml@main which is a bit unusual (this one directly references the yaml file) compared to other actions for example: fastify/github-action-merge-dependabot@v2.7.1

Other than these two notes I think it's working good.
Update: As @simoneb pointed out, this is a reusable workflow and the reference is correct (https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#calling-a-reusable-workflow)

Closes #204

[radomird]

Hi @dominykas I've added your reusable workflow to this repo. It works fine.

[simoneb]

the "link" to the action is pkgjs/action/.github/workflows/node-test.yaml@main which is a bit unusual

that's because this is not an action, it's a reusable workflow https://docs.github.com/en/actions/learn-github-actions/reusing-workflows

[simoneb]

please check out the source code of the reusable workflow to see why it would not work

[radomird]

that's because this is not an action, it's a reusable workflow https://docs.github.com/en/actions/learn-github-actions/reusing-workflows

Updated the PR description.

please check out the source code of the reusable workflow to see why it would not work

What do you mean? What wouldn't work?

[simoneb]

Overall I like the idea but there's one thing I'm still not sure about. How do we version this? Do we always have to reference the main branch to use this reusable workflow? Is there a way to use it as an action instead?

[radomird]

Overall I like the idea but there's one thing I'm still not sure about. How do we version this? Do we always have to reference the main branch to use this reusable workflow? Is there a way to use it as an action instead?

I think reusable workflows can be versioned the same way as actions, either by tag or addressing specific branch, according to this: https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#reusable-workflows-and-workflow-templates

[simoneb]

Overall I like the idea but there's one thing I'm still not sure about. How do we version this? Do we always have to reference the main branch to use this reusable workflow? Is there a way to use it as an action instead?

I think reusable workflows can be versioned the same way as actions, either by tag or addressing specific branch, according to this: https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#reusable-workflows-and-workflow-templates

Yes we would have to, we can't reference a branch name for various reasons. Can you try to figure out if dependabot works for reusable workflows too? e.g. a new tag is created, does dependabot create a PR to update it in the way it does for github actions?

[dominykas]

This workflow will be versioned - I'd like the API to settle down a little bit before I do that, though, still collecting feedback. I hope to do that early next year - I'll keep an eye on this repo as well and will open a PR once v1 is ready.

I'd also like to add some basic tooling to do the versioning (i.e. I need something that will add a v1, v1.1 when v1.1.1 is added).

[dominykas]

Can you try to figure out if dependabot works for reusable workflows too?

If it doesn't, there's always renovate (it supports regex based managers, if all else fails).

[simoneb]

This workflow will be versioned - I'd like the API to settle down a little bit before I do that, though, still collecting feedback. I hope to do that early next year - I'll keep an eye on this repo as well and will open a PR once v1 is ready.

I'd also like to add some basic tooling to do the versioning (i.e. I need something that will add a v1, v1.1 when v1.1.1 is added).

We have that feature (creating the various tags) in https://github.com/nearform/optic-release-automation-action

[simoneb]

Can you try to figure out if dependabot works for reusable workflows too?

If it doesn't, there's always renovate (it supports regex based managers, if all else fails).

we've decommissioned renovate everywhere

[simoneb]

@radomird let's keep this PR here. I like the net result but let's wait until the tool reaches its first release. Note that we will need to change the required checks to reflect the checks run by the tool

[radomird]

@radomird let's keep this PR here. I like the net result but let's wait until the tool reaches its first release. Note that we will need to change the required checks to reflect the checks run by the tool

Sounds good. I'll move it to "On hold"

[dominykas]

let's wait until the tool reaches its first release

FWIW, the stuff that you're using is unlikely to change at v1, unless it's specifically the @main you're concerned about for other reasons.

[dominykas]

@simoneb would you be happy enough to start using it if I tagged a @v0.1 there (rather than just @main)?

There's some hesitance about tagging a @v1... (not that I agree with that hesitance)

[simoneb]

@simoneb would you be happy enough to start using it if I tagged a @v0.1 there (rather than just @main)?

There's some hesitance about tagging a @v1... (not that I agree with that hesitance)

Yes. I'm honestly not completely sold on the idea of using this approach thoroughly across repos, but happy to try it out and see how it works out.

Just to mention one thing, the required checks in the repo need to be aligned, but I'm sure there are more gotchas we'll need to look out for.

[dominykas]

not completely sold on the idea of using this approach thoroughly across repos

Any specific concerns?

the required checks in the repo need to be aligned

Yeah, the naming of the checks is annoying. I wonder if Github has a way of setting the name explicitly 🤔 It's causing me trouble elsewhere as well...

Anyways, I tagged a v0.1.0 today - it's also available at v0 and v0.1.

[simoneb]

@radomird can you please pick this up again? Thanks

[dominykas]

Re build/check naming - I have some changes pending to make these more predictable.