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

Add alpha release publication GitHub workflow #115

Merged
merged 2 commits into from
Jun 8, 2023
Merged

Conversation

frankhinek
Copy link
Contributor

@frankhinek frankhinek commented Jun 7, 2023

This PR primarily adds a new GitHub Actions workflow to enable on-demand publishing of alpha releases. The contributing guide was updated to reflect the versioning scheme and publication process for general consumption and alpha releases.

Additionally, a few minor tweaks were made to existing GitHub Action workflows, including renaming the dev site notification workflow definition.

All workflows were tested using a dummy repo I maintain to ensure that the GH runs and NPM publishing work as intended.

@frankhinek frankhinek marked this pull request as ready for review June 7, 2023 22:21
@frankhinek frankhinek added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 7, 2023
@codecov
Copy link

codecov bot commented Jun 7, 2023

Codecov Report

Merging #115 (f9d3fd5) into main (6e26796) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #115   +/-   ##
=======================================
  Coverage   65.97%   65.97%           
=======================================
  Files          31       31           
  Lines        3447     3447           
  Branches      195      195           
=======================================
  Hits         2274     2274           
  Misses       1171     1171           
  Partials        2        2           
Components Coverage Δ
crypto 0.00% <ø> (ø)
dids 48.61% <ø> (ø)
web5 81.32% <ø> (ø)
web5-agent 0.00% <ø> (ø)
web5-proxy-agent 0.00% <ø> (ø)
web5-user-agent 79.49% <ø> (ø)

@mistermoe
Copy link
Contributor

@frankhinek this is awesome.

only question that comes to mind is: can you run actions on a specific branch? i noticed workflow_dispatch as the trigger (which allows for running the action via the github UI). does workflow_dispatch need a specific input to specify the branch it should run on?

e.g.

on:
  workflow_dispatch:
    inputs:
      branch_name:
        description: 'Branch to run on'
        required: true
        default: 'main'

@frankhinek
Copy link
Contributor Author

only question that comes to mind is: can you run actions on a specific branch? i noticed workflow_dispatch as the trigger (which allows for running the action via the github UI). does workflow_dispatch need a specific input to specify the branch it should run on?

@mistermoe Yes, you can run on a specific branch. No, workflow dispatch inputs aren't necessary nor ideal because they are free form text input and prone to typos. GitHub UI automatically provides a drop-down menu populated with the actual branch names:

run-workflow

@mistermoe
Copy link
Contributor

@frankhinek frankhinek merged commit dd83cec into main Jun 8, 2023
@frankhinek frankhinek deleted the gh-action-alpha branch June 8, 2023 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants