Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need for urgent changes in GitHub Actions automation #335

Closed
derberg opened this issue May 30, 2023 · 3 comments · Fixed by #345
Closed

Need for urgent changes in GitHub Actions automation #335

derberg opened this issue May 30, 2023 · 3 comments · Fixed by #345
Assignees
Labels
area/ci-cd Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com

Comments

@derberg
Copy link
Member

derberg commented May 30, 2023

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 asyncapi/.github#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 asyncapi/.github#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 derberg added the area/ci-cd Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. label May 30, 2023
@Mrc0113
Copy link
Contributor

Mrc0113 commented Sep 11, 2023

@derberg since this was opened has it been completed on another code generator template that you would recommend is used as a template for this work?

(I know you have also provided some info above)

@derberg
Copy link
Member Author

derberg commented Sep 11, 2023

@Mrc0113 you can just do the same as in bundler repo for example as this template is also a simple repo without any custom workflows

@derberg
Copy link
Member Author

derberg commented Oct 3, 2023

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 derberg added the Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com label Oct 3, 2023
@CameronRushton CameronRushton self-assigned this Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci-cd Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants