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

[BRE-224] Create a GitHub release workflows for sdk #1078

Merged

Conversation

michalchecinski
Copy link
Contributor

🎟️ Tracking

https://bitwarden.atlassian.net/browse/BRE-224

📔 Objective

Create and/or split workflow to create a GitHub Release for SDK parts.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@michalchecinski michalchecinski requested a review from a team as a code owner September 25, 2024 16:09
Copy link
Contributor

github-actions bot commented Sep 25, 2024

Logo
Checkmarx One – Scan Summary & Details85730e7b-5c96-4790-99a3-ad7e7354eed8

New Issues

Severity Issue Source File / Package Checkmarx Insight
MEDIUM Unpinned Actions Full Length Commit SHA /release-dotnet.yml: 55 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /build-ruby.yml: 25 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /release-bws.yml: 52 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /release-ruby.yml: 51 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-rust-crates.yml: 77 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-ruby.yml: 92 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-bws.yml: 94 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-python.yml: 108 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-bws.yml: 170 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-wasm.yml: 87 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /release-bws.yml: 44 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-bws.yml: 164 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-dotnet.yml: 88 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
MEDIUM Unpinned Actions Full Length Commit SHA /publish-napi.yml: 111 Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...

Fixed Issues

Severity Issue Source File / Package
MEDIUM Unpinned Actions Full Length Commit SHA /release-cli.yml: 58
MEDIUM Unpinned Actions Full Length Commit SHA /release-wasm.yml: 113
MEDIUM Unpinned Actions Full Length Commit SHA /release-cli.yml: 192
MEDIUM Unpinned Actions Full Length Commit SHA /release-cli.yml: 66
MEDIUM Unpinned Actions Full Length Commit SHA /publish-rust-crates.yml: 43
MEDIUM Unpinned Actions Full Length Commit SHA /release-cli.yml: 124
MEDIUM Unpinned Actions Full Length Commit SHA /release-cli.yml: 198
MEDIUM Unpinned Actions Full Length Commit SHA /release-wasm.yml: 107

Copy link

codecov bot commented Sep 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.31%. Comparing base (2868f26) to head (b0de9ef).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1078   +/-   ##
=======================================
  Coverage   58.31%   58.31%           
=======================================
  Files         192      192           
  Lines       13486    13486           
=======================================
  Hits         7865     7865           
  Misses       5621     5621           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.github/workflows/release-wasm.yml Outdated Show resolved Hide resolved
.github/workflows/release-rust-crates.yml Outdated Show resolved Hide resolved
.github/workflows/release-python.yml Outdated Show resolved Hide resolved
.github/workflows/release-python.yml Outdated Show resolved Hide resolved
.github/workflows/release-napi.yml Outdated Show resolved Hide resolved
.github/workflows/publish-napi.yml Outdated Show resolved Hide resolved
.github/workflows/publish-java.yml Show resolved Hide resolved
.github/workflows/publish-dotnet.yml Outdated Show resolved Hide resolved
.github/workflows/publish-dotnet.yml Outdated Show resolved Hide resolved
.github/workflows/build-ruby.yml Show resolved Hide resolved
michalchecinski and others added 9 commits September 26, 2024 12:00
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
.github/workflows/publish-wasm.yml Outdated Show resolved Hide resolved
workflow: build-wasm.yml
path: ${{ github.workspace }}/languages/js/wasm
workflow_conclusion: success
branch: ${{ inputs.release_type == 'Dry Run' && 'main' || github.ref_name }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
branch: ${{ inputs.release_type == 'Dry Run' && 'main' || github.ref_name }}
branch: main

Is the Download artifacts step being used, or the one below this for Download artifact?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The one below. Fixed it.

Comment on lines 16 to 20
npm_publish:
description: "Publish to NPM registry"
required: true
default: true
type: boolean
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
npm_publish:
description: "Publish to NPM registry"
required: true
default: true
type: boolean

Since this workflow only publishes to NPM, we can remove the input. It would do nothing if the box was not checked.

Copy link
Contributor Author

@michalchecinski michalchecinski Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

name: Publish NPM
runs-on: ubuntu-22.04
needs: setup
if: inputs.npm_publish
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if: inputs.npm_publish

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

.github/workflows/build-ruby.yml Outdated Show resolved Hide resolved
.github/workflows/build-ruby.yml Outdated Show resolved Hide resolved
michalchecinski and others added 5 commits September 26, 2024 15:40
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
.github/workflows/publish-wasm.yml Outdated Show resolved Hide resolved
.github/workflows/publish-wasm.yml Outdated Show resolved Hide resolved
.github/workflows/publish-wasm.yml Outdated Show resolved Hide resolved
michalchecinski and others added 3 commits September 27, 2024 12:13
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
@michalchecinski michalchecinski merged commit a6fd484 into main Sep 30, 2024
97 of 99 checks passed
@michalchecinski michalchecinski deleted the BRE-224-Create-a-GitHub-Release-workflows-for-SDK branch September 30, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants