ci: add generic version bump and pr testing and relese workflows for nodejs #21

derberg · 2021-01-12T09:30:16Z

Description

these are workflows that will be populated to all repos, even non-nodejs, but will only work if package.json is in the root

version bump

the biggest advantage of this one is that PR creation action that we depend on will be updated globally only in this workflow (easier to fix issues like The automated release is failing 🚨 markdown-template#55), and will not be an integral part of individual release workflows
we will have to maintain 2 scripts in every nodejs project:
- generate:assets that will run scripts like the ones about generating docs. toc in readme or types
- bump:version that will run scripts to bump version of the package in package.json

pr testing

changing what nodejs version we are testing in all repos will be as simple as updating just this one single workflow
we introduce matrix testing on not only linux but also macos and windows

release workflow
This is what I'm happy with the most, that was not my intention at the beginning but after testing it with React component that had the most complicated release workflow I'm now sure that we can have a simple generic release workflow that can be easily extended per repo with the approach we did in react https://github.com/asyncapi/asyncapi-react/blob/master/.github/workflows/release-wc-and-playground.yml

Related issue(s)
See also asyncapi/spec#423

derberg · 2021-01-12T09:31:44Z

.github/workflows/version-bump.yml

+        # We make sure here no tags are added by default as they are already added by release workflow
+        # --allow-same-version is set in case someone forgot and updated package.json manually and we want to avoide this action to fail and raise confusion
+        # run: npm --no-git-tag-version --allow-same-version version ${{github.event.release.tag_name}}
+        run: VERSION=${{github.event.release.tag_name}} npm bump:version


it is done this way, with exporting version as environment variable as it is easier this way to later implement npm bump:version script in monorepos

derberg · 2021-01-12T09:33:01Z

.github/workflows/version-bump.yml

+      - name: Check if Node.js project and has package.json
+        id: packagejson
+        run: test -e ./package.json && "::set-output name=exists::true" || "::set-output name=exists::false"
+      - if: steps.packagejson.outputs.exists == 'true'


yes, we need to put if to every step instead of doing one step with if that checks false and then gracefully stops the job. Why? as github action runner doesn't support that yet :( actions/runner#662

derberg · 2021-01-12T11:23:16Z

this is what happens to release workflow after removing bump and or creation from it -> asyncapi/html-template#125

jonaslagoni

When this is approved, how will it handle templates which does not contain these new scripts, will it just fail the task @derberg ?

derberg · 2021-01-12T12:32:40Z

@jonaslagoni it won't handle them gracefully. The job will fail. But it is not a problem as it won't happen 😄
Once this is approved, I know it is a direction we want to take and I have to first go to all repos with the current release pipeline and adjust it:

add/adjust scripts
remove bump and or creation from releases
etc

So this one is not merged until PRs from all the other repos are merged.
I also want to add all those new "global" workflows manually to react component, and make adjustments there and run real release there to make sure all those ideas work as expected

jonaslagoni

LGTM 👍

derberg · 2021-01-12T12:43:26Z

@jonaslagoni awesome. What do you think about taking the same approach (generic nodejs workflow with first step that checks if package.json is there) for PR testing and release workflow in general -> https://github.com/asyncapi/html-template/pull/125/files#r555705827

jonaslagoni · 2021-01-12T12:55:49Z

@jonaslagoni awesome. What do you think about taking the same approach (generic nodejs workflow with first step that checks if package.json is there) for PR testing and release workflow in general -> https://github.com/asyncapi/html-template/pull/125/files#r555705827

@derberg I dont have any objections in standardize the release process for npm repositories 👍

derberg · 2021-01-12T13:12:17Z

@jonaslagoni I'll update this PR then, let's see how it will look like

derberg · 2021-01-12T18:57:17Z

ok, now this PR has 3 new global workflows that will run on nodejs projects only.

I don't like this:

      - if: steps.packagejson.outputs.exists == 'true'
        name: Setup Node.js
        uses: actions/setup-node@v1
        with:
          node-version: 14
      - if: steps.packagejson.outputs.exists == 'true'

but there is no alternative now, spent some more hours on investigation. Light in the tunnel for the future is that we could just do the following condition on a job level if: contains(github.event.repository.topics, 'nodejs') and decide that only repo with such topic will apply such a workflow (which is handy) but this is not going to happen soon as topics (even though old feature) are not yet part of repository event 😱 -> https://github.community/t/why-topics-are-not-part-of-repository/155130

derberg · 2021-01-12T19:26:15Z

@jonaslagoni I updated this PR with generic workflows for release and pr testing. As a result, this is how it will look like in other projects once this PR is merged -> https://github.com/asyncapi/html-template/pull/125/files

Looks promising but as mentioned before now I will do the cleanup in a most complex project, react component

derberg · 2021-01-19T18:48:07Z

@jonaslagoni @magicmatatjahu I updated this PR, including the description. I think it is awesome that we can have generic release workflow for all nodejs projects. All workflows tested against asyncapi-react with success

Of course, this is not going to be merged once I cleanup release workflows across all repos

derberg commented Jan 12, 2021

View reviewed changes

derberg mentioned this pull request Jan 12, 2021

Improve CI workflows in AsyncAPI repositories asyncapi/spec#423

Closed

derberg requested review from jonaslagoni and magicmatatjahu January 12, 2021 09:38

jonaslagoni reviewed Jan 12, 2021

View reviewed changes

jonaslagoni approved these changes Jan 12, 2021

View reviewed changes

derberg changed the title ~~chore: add generic version bump workflow for nodejs~~ chore: add generic version bump pr testing and relese workflows for nodejs Jan 12, 2021

derberg mentioned this pull request Jan 13, 2021

ci: cleanup release workflow asyncapi/asyncapi-react#218

Merged

derberg changed the title ~~chore: add generic version bump pr testing and relese workflows for nodejs~~ ci: add generic version bump pr testing and relese workflows for nodejs Jan 19, 2021

derberg changed the title ~~ci: add generic version bump pr testing and relese workflows for nodejs~~ ci: Add generic version bump and pr testing and relese workflows for nodejs Jan 19, 2021

fmvilas approved these changes Jan 19, 2021

View reviewed changes

derberg changed the title ~~ci: Add generic version bump and pr testing and relese workflows for nodejs~~ ci: add generic version bump and pr testing and relese workflows for nodejs Jan 20, 2021

jonaslagoni mentioned this pull request Jan 22, 2021

chore: prepared for new global release workflow asyncapi/modelina#6

Merged

derberg added 14 commits January 26, 2021 12:19

chore: add generic version bump workflow for nodejs

514519e

chore: fix npm triggering

f2a734f

add missing echo

0741b9d

add release and pr testing for node

3024860

fix echoing

cc62385

Update if-nodejs-pr-testing.yml

14eff3b

Update if-nodejs-pr-testing.yml

56ec773

Update if-nodejs-release.yml

77c9c98

enforce bash so it works on windows

b9182d3

fix echo

dbe8dbc

adjust names

ca004a9

use npm install

eaebbbb

update workflows after checking them in react component repo

404377c

improvement after cleanup done in other repos

84f8eb8

derberg force-pushed the add-generic-version-bump branch from d7f411d to 84f8eb8 Compare January 26, 2021 11:20

use latest global with more logs

8db3d98

derberg merged commit 94c319a into asyncapi:master Jan 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: add generic version bump and pr testing and relese workflows for nodejs #21

ci: add generic version bump and pr testing and relese workflows for nodejs #21

derberg commented Jan 12, 2021 •

edited

Loading

derberg Jan 12, 2021

derberg Jan 12, 2021

derberg commented Jan 12, 2021

jonaslagoni left a comment •

edited

Loading

derberg commented Jan 12, 2021

jonaslagoni left a comment

derberg commented Jan 12, 2021

jonaslagoni commented Jan 12, 2021

derberg commented Jan 12, 2021

derberg commented Jan 12, 2021

derberg commented Jan 12, 2021

derberg commented Jan 19, 2021

ci: add generic version bump and pr testing and relese workflows for nodejs #21

ci: add generic version bump and pr testing and relese workflows for nodejs #21

Conversation

derberg commented Jan 12, 2021 • edited Loading

derberg Jan 12, 2021

Choose a reason for hiding this comment

derberg Jan 12, 2021

Choose a reason for hiding this comment

derberg commented Jan 12, 2021

jonaslagoni left a comment • edited Loading

Choose a reason for hiding this comment

derberg commented Jan 12, 2021

jonaslagoni left a comment

Choose a reason for hiding this comment

derberg commented Jan 12, 2021

jonaslagoni commented Jan 12, 2021

derberg commented Jan 12, 2021

derberg commented Jan 12, 2021

derberg commented Jan 12, 2021

derberg commented Jan 19, 2021

derberg commented Jan 12, 2021 •

edited

Loading

jonaslagoni left a comment •

edited

Loading