simulator icon indicating copy to clipboard operation
simulator copied to clipboard

Need for urgent changes in GitHub Actions automation

Open derberg opened this issue 2 years ago • 8 comments

This issue defines a list of tasks that need to be performed in this repo to make sure it's ci/cd automation works long term without any issues.

It is up to maintainers to decide if it must be addressed in one or multiple PRs.

Below are 3 different sections describing 3 different important ci/cd changes.

IMPORTANT-START For GitHub workflows that contain This workflow is centrally managed in https://github.com/asyncapi/.github/ you do not have to perform any work. These workflows were already updated through the update in .github. The only exception is the workflows related to nodejs release. More details in Upgrade Release pipeline - in case of nodejs projects section IMPORTANT-END

Deprecation of way data is shared between steps

Every single GitHub Action workflow that has echo "::set-output name={name}::{value}" need to be updated to follow echo "{name}={value}" >> $GITHUB_OUTPUT

We do not yet know when set-output will stop working. Previous disable date was 31.05 but now then say community needs more time.

For more details read official article from GitHub

Deprecation of node12

2nd bullet point is still relevant for you even if your projects in not nodejs project

  • Every single workflow that uses setup-node action needs an update to follow v3 version of this action, and make sure minimum node 14 is used
  • Now this part is more complex. Problem with node12 is that node-based GitHub Actions were using it in majority as a runtime environment. Look for example at this action.yaml file for setup-node action v2. So the job that you have to do is go through all the workflows, and verify every single action that you use, make sure you are using the latest version that is not based on node12. I already did review a lot of actions as part of this PR so maybe you will find some actions there and can copy from me. For example action/checkout needs to be updated to v3.

Node12 end of support in action is probably September 27th.

For more details read official article from GitHub

Upgrade Release pipeline - in case of nodejs projects

ignore this section if your project is not nodejs project

You have 2 options. You can:

A. choose to switch to new release pipeline using instruction from https://github.com/asyncapi/.github/issues/205

B. stay with old release pipeline, and manually update GitHub workflows and actions used in it, you can inspire a lot from this PR https://github.com/asyncapi/.github/pull/226

I definitely recommend going with A

Workflows related to release:

  • .github/workflows/if-nodejs-release.yml
  • .github/workflows/if-nodejs-version-bump.yml
  • .github/workflows/bump.yml

derberg avatar May 30 '23 12:05 derberg

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

github-actions[bot] avatar May 30 '23 12:05 github-actions[bot]

i will take a look

NektariosFifes avatar Jul 07 '23 09:07 NektariosFifes

@derberg The repo contains This workflow is centrally managed in https://github.com/asyncapi/.github/ i do not have to change something?

NektariosFifes avatar Jul 10 '23 00:07 NektariosFifes

@NektariosFifes if you have no custom workflows, and only these from .githb then the only thing you should do is Upgrade Release pipeline - in case of nodejs projects

derberg avatar Jul 19 '23 12:07 derberg

@derberg i do not have the option to add a topic through the project's landing page. Maybe i dont have permissions? Should i manually add the workflow files?

NektariosFifes avatar Aug 13 '23 09:08 NektariosFifes

I see below

Screenshot 2023-09-04 at 15 39 33

don't you see setting button?

Screenshot 2023-09-04 at 15 40 08

derberg avatar Sep 04 '23 13:09 derberg

Scope of this issue

Cleanup package.json from the following:

  • remove script "release": "semantic-release"
  • remove the following devDependencies and then run npm install
    @semantic-release/commit-analyzer
    @semantic-release/github
    @semantic-release/npm
    @semantic-release/release-notes-generator
    conventional-changelog-conventionalcommits
    semantic-release
    
  • remove release property (object)

in PR please tag @derberg as I need to review + merge + do some global config changes

derberg avatar Oct 03 '23 15:10 derberg

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Feb 01 '24 00:02 github-actions[bot]