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.

Sign up for GitHub

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

Jump to bottom

Add release workflows #138

Merged
merged 4 commits into from
Dec 1, 2022
Merged

Add release workflows #138

merged 4 commits into from
Dec 1, 2022

Conversation

gaiksaya
Copy link
Member

Description

This change adds release workflows to publish OUI on https://www.npmjs.com/
Please see opensearch-project/opensearch-build#1234 for design details of end to end workflow.

TL;DR:
When a tag is pushed to this repository, it will generate a draft release. The draft release will trigger the jenkins job (see Files Changed for attached jenkins file) that publishes the client to npmjs. Once the release is successful, the drafted release is published on GitHub.

Issues Resolved

opensearch-project/opensearch-build#2900

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • All tests pass
    • yarn lint
    • yarn test-unit
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@gaiksaya
Add release workflows
78ecc09 
Signed-off-by: Sayali Gaikawad <[email protected]>
@gaiksaya
test
7511974 
Signed-off-by: Sayali Gaikawad <[email protected]>
@gaiksaya
test
13d5a25 
Signed-off-by: Sayali Gaikawad <[email protected]>
@gaiksaya gaiksaya requested a review from a team as a code owner November 30, 2022 21:10
@gaiksaya
Copy link
Member Author

Taking care of few things on infra side before this gets merged. Please review till then.
Thanks!
cc: @AMoo-Miki @rednaksi91

AMoo-Miki
AMoo-Miki previously approved these changes Nov 30, 2022
View reviewed changes
Copy link
Collaborator

@AMoo-Miki AMoo-Miki left a comment

Choose a reason for hiding this comment

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

Thanks

@BSFishy
Copy link
Contributor

BSFishy commented Nov 30, 2022

Will this work for pre-releases, for example, if we want to release a 1.2.3-alpha version to NPM for alpha testing?

@gaiksaya
Copy link
Member Author

gaiksaya commented Dec 1, 2022 •
edited
Loading

Will this work for pre-releases, for example, if we want to release a 1.2.3-alpha version to NPM for alpha testing?

Yes!
The workflows do not care what version you are releasing. These are the commands that it runs when jenkins workflow is run https://github.com/opensearch-project/opensearch-build-libraries/blob/1.1.1/vars/publishToNpm.groovy#L20
So along as you have the right version in package.json and you are pushing the tag to trigger the workflows, we are good

BSFishy
BSFishy previously approved these changes Dec 1, 2022
View reviewed changes
@gaiksaya
Copy link
Member Author

gaiksaya commented Dec 1, 2022

Hey @AMoo-Miki @BSFishy Not sure where to add the release process details. Something similar to https://github.com/opensearch-project/opensearch-js/blob/main/RELEASING.md#releasing
Any idea?

@AMoo-Miki
Copy link
Collaborator

We don't have one but we could just steal that file entirely.

@gaiksaya
Add releasing.md file
aaa0a37 
Signed-off-by: Sayali Gaikawad <[email protected]>
@gaiksaya gaiksaya dismissed stale reviews from BSFishy and AMoo-Miki via aaa0a37 December 1, 2022 00:31
@gaiksaya
Copy link
Member Author

gaiksaya commented Dec 1, 2022

We don't have one but we could just steal that file entirely.

Added the file called RELEASING.md that contains the details on how to release this component.
Thanks!

@gaiksaya gaiksaya requested review from AMoo-Miki and BSFishy December 1, 2022 00:32
BSFishy
BSFishy approved these changes Dec 1, 2022
View reviewed changes
Copy link
Contributor

@BSFishy BSFishy left a comment

Choose a reason for hiding this comment

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

I think OUI is going to make a push to support a smaller group of versions than OSD does, but we'll have a larger discussion about that outside of this PR

@gaiksaya
Copy link
Member Author

gaiksaya commented Dec 1, 2022

Yeah incrementing the version after the release makes sure the development is tracked for next iteration. I'll set the webhooks for this repo. Will update this PR once done.
Thanks!

@gaiksaya gaiksaya merged commit 01515a8 into opensearch-project:main Dec 1, 2022
@gaiksaya gaiksaya deleted the release-workflows branch December 1, 2022 18:18
@gaiksaya
Copy link
Member Author

gaiksaya commented Dec 1, 2022

This repository is set for automated releases. Push a tag when you are ready. Let us know in case of any failures.
Thanks!

@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Feb 28, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 28, 2023
@github-actions
Add release workflows (#138)
1fee581 
* Add release workflows

Signed-off-by: Sayali Gaikawad <[email protected]>
(cherry picked from commit 01515a8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
BSFishy pushed a commit that referenced this pull request Feb 28, 2023
@opensearch-trigger-bot @github-actions @seanneumann
Add release workflows (#138) (#542)
15b93fd 
* Add release workflows


(cherry picked from commit 01515a8)

Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Sean Neumann <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BSFishy BSFishy BSFishy approved these changes

@AMoo-Miki AMoo-Miki AMoo-Miki approved these changes

Assignees
No one assigned
Labels
backport 1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gaiksaya @BSFishy @AMoo-Miki