release workflows

[jacobdotcosta]

Provides 2 workflows:

• tag-for-release.yaml: Manual workflow that creates a PR for release, with updated version numbers.
• release.yaml: Create release for tag. Triggered automatically from merged Release PR.

Closes #49

[jacobdotcosta]

I think that we need also a step to verify if the package(s) that we would like to publish part of a release do not yet exist on npmjs.org !

Do you mean check if packages with the same release number already exist on npmjs.org? There shouldn't be as this should be the only way of publishing the artifacts.

[cmoulliard]

Do you mean check if packages with the same release number already exist on npmjs.org? There shouldn't be as this should be the only way of publishing the artifacts.

Yes or locally. Why ? npmjs.org don't support anymore that we override a package already pushed as that was possible in the past

[jacobdotcosta]

I have it but I'm not sure where to place the validation. Should it be placed on the first workflow to prevent the creation of the version PR tag?

[cmoulliard]

I have it but I'm not sure where to place the validation. Should it be placed on the first workflow to prevent the creation of the version PR tag?

That makes sense

[cmoulliard]

Can you add a section to the README to explain what folks should do to trigger a new release ? @jacobdotcosta

[jacobdotcosta]

Added a RELEASE.md file documenting the release process.

[jacobdotcosta]

The 3 git workflows include the following actions:

        - name: Build all plugins
          uses: ./.github/actions/build
          with:
            node_version: ${{ matrix.node-version }}

        - name: Verify dist files generated (*.d.ts)
          run: |
            ls -la plugins/*/dist

I think that only the flow tag-for-release.yaml should include them as it makes no sense to tag/release and push to npmjs.org if we cannot compile the typescript files, generate the javascript files

I agree that the release workflow won't need this but are you sure the Publish workflow also doesn't need it? Won't it need the project to have been built in order to publish it to npmjs.org?

[cmoulliard]

I agree that the release workflow won't need this but are you sure the Publish workflow also doesn't need it? Won't it need the project to have been built in order to publish it to npmjs.org?

As we don't save the artifacts built (= js files), then such a build is needed when we push on npmjs.org. Nevertheless, in order to tag the git repo, we should also do a build to be sure that project is in good health ;-)

[jacobdotcosta]

I agree that the release workflow won't need this but are you sure the Publish workflow also doesn't need it? Won't it need the project to have been built in order to publish it to npmjs.org?

As we don't save the artifacts built (= js files), then such a build is needed when we push on npmjs.org. Nevertheless, in order to tag the git repo, we should also do a build to be sure that project is in good health ;-)

Great, so I'll leave this as is.

[cmoulliard]

Great, so I'll leave this as is.

No. Here is what we should do concerning the existing jobs @jacobdotcosta

• tag-for-release.yaml: build nodejs plugins as it makes no sense to tag and create a PR if current code cannot be compiled (= tsc) and build (= generate js artifacts). This job should be renamed as we don't tag it (from git point of view) BUT we bump the nodejs packager version and create a PR
• release.yaml: Remove nodejs build step (as this has been done by the previous job creating the PR). Rename the title from release to tag-and-create-release
• npm-publish: build nodejs artfifacts (= yanr tsc; yarn build) FROM the git tagged repository, publish on npmjs.org

[jacobdotcosta]

Made several improvements to the docs. Could you take another look @cmoulliard ?