Create publishToNpm library #21

gaiksaya · 2022-10-25T22:40:52Z

Description

Adds publishToNpm library that can be used to publish packages to NPM under @opensearch-project name space.
The library takes 2 inputs which is Github repository and the tag

Issues Resolved

resolves opensearch-project/opensearch-build#2637

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.

Signed-off-by: Sayali Gaikawad <[email protected]>

peterzhuamazon · 2022-10-26T19:31:45Z

vars/standardReleasePipeline.groovy

@@ -40,7 +40,6 @@ void call(Map args = [:], Closure body) {
            always {
                script {
                    postCleanup()
-                    sh 'docker image prune -f --all'


Why remove this?

Caused an error looking for docker command on agent node.

Will this affect any other jenkinsfile that calls this?
Ex: We want to do the cleanup for docker build.

No, this file is not used anywhere today.

shouldn't agent node supposed to have docker installed? @gaiksaya

@rishabh6788 this file is using docker container running on a jenkins linux agent.
The agent can have docker but the container doesnt have to.
Except docker builder.

understood, thank you!

peterzhuamazon · 2022-10-26T19:32:35Z

vars/publishToNpm.groovy

+    checkout([$class: 'GitSCM', branches: [[name: "${args.tag}" ]], userRemoteConfigs: [[url: "${args.repository}" ]]])
+
+    withCredentials([string(credentialsId: 'publish-to-npm-token', variable: 'NPM_TOKEN')]){
+        sh """npm set registry "https://registry.npmjs.org"; npm set //registry.npmjs.org/:_authToken ${NPM_TOKEN}; npm publish --dry-run && npm publish --access public"""


Prefer writing this in multiple lines for easier visibility.

sh """ <code> """

Makes its difficult to test things due to whitespace. Hence used the above approach. Similar to https://github.com/opensearch-project/opensearch-build-libraries/blob/main/vars/copyContainer.groovy#L35

Huh, I do find it not ideal for reading, what would happen if the code block is too long to put into one line?

This was not long enough that's why used this way. If its very long we can use the approach you suggested or try to break it down.

I think from my experience, we used to publish the client to staging NPM before final publish. Would that be performed on the Jenkinsfile level which calls this library?

@zelinh We won't be dealing with staging. If component team wants to follow that they can do on their own. We will only be directly releasing on prod platform

zelinh · 2022-10-27T06:41:57Z

vars/publishToNpm.groovy

+    checkout([$class: 'GitSCM', branches: [[name: "${args.tag}" ]], userRemoteConfigs: [[url: "${args.repository}" ]]])
+
+    withCredentials([string(credentialsId: 'publish-to-npm-token', variable: 'NPM_TOKEN')]){
+        sh """npm set registry "https://registry.npmjs.org"; npm set //registry.npmjs.org/:_authToken ${NPM_TOKEN}; npm publish --dry-run && npm publish --access public"""


I think from my experience, we used to publish the client to staging NPM before final publish. Would that be performed on the Jenkinsfile level which calls this library?

zelinh · 2022-10-27T06:44:56Z

vars/publishToNpm.groovy

+    checkout([$class: 'GitSCM', branches: [[name: "${args.tag}" ]], userRemoteConfigs: [[url: "${args.repository}" ]]])
+
+    withCredentials([string(credentialsId: 'publish-to-npm-token', variable: 'NPM_TOKEN')]){
+        sh """npm set registry "https://registry.npmjs.org"; npm set //registry.npmjs.org/:_authToken ${NPM_TOKEN}; npm publish --dry-run && npm publish --access public"""


Maybe we could add one another command npm logout at the beginning to make sure we don't accidentally publish to somewhere else or this could be replaced with new login?

We are using a token and not logging into the account so no need to log out. The scope of scope is within the withCredentials.

gaiksaya · 2022-10-27T17:05:11Z

I think from my experience, we used to publish the client to staging NPM before final publish. Would that be performed on the Jenkinsfile level which calls this library?

@zelinh We won't be dealing with staging. If component team wants to follow that they can do on their own. We will only be directly releasing on prod platform

* Add npm publishing lib Signed-off-by: Sayali Gaikawad <[email protected]>

* Added precision for codecov (#17) * Added precision for codecov Signed-off-by: Owais Kazi <[email protected]> * Add standard release pipeline library (#11) * Add standard release pipeline library Signed-off-by: Sayali Gaikawad <[email protected]> * Create publishToNpm library (#21) * Add npm publishing lib Signed-off-by: Sayali Gaikawad <[email protected]> * Add standard release pipeline library with generic trigger (#22) Signed-off-by: Sayali Gaikawad <[email protected]> * Add release workflow and readme (#23) * Add release.yml Signed-off-by: Sayali Gaikawad <[email protected]> * Fix releasing.md (#25) Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: Sayali Gaikawad <[email protected]> * Fix credential type for github bot (#26) * Fix credential type for github bot Signed-off-by: Sayali Gaikawad <[email protected]> * Add untriaged label to new github issues (#27) Signed-off-by: Rishabh Singh <[email protected]> Signed-off-by: Rishabh Singh <[email protected]> * Remove docker check for windows gradle check (#28) * Remove docker check for windows gradle check Signed-off-by: Peter Zhu <[email protected]> * add test results Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Remove docker check for windows gradle check (#28) * Remove docker check for windows gradle check Signed-off-by: Peter Zhu <[email protected]> * add test results Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * upgrade to 1.1.1 with changes in #28 Signed-off-by: Peter Zhu <[email protected]> * Test results Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Owais Kazi <[email protected]> Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: Rishabh Singh <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Owais Kazi <[email protected]> Co-authored-by: Sayali Gaikawad <[email protected]> Co-authored-by: Rishabh Singh <[email protected]>

gaiksaya added 5 commits October 20, 2022 15:38

Add npm publishing lib

fdd1f8a

Signed-off-by: Sayali Gaikawad <[email protected]>

Fix lib

51d52af

Signed-off-by: Sayali Gaikawad <[email protected]>

Add tests for npm lib

e2059a3

Signed-off-by: Sayali Gaikawad <[email protected]>

test

a3b82ee

Signed-off-by: Sayali Gaikawad <[email protected]>

test

de7c015

Signed-off-by: Sayali Gaikawad <[email protected]>

gaiksaya requested a review from a team as a code owner October 25, 2022 22:40

gaiksaya self-assigned this Oct 25, 2022

peterzhuamazon reviewed Oct 26, 2022

View reviewed changes

zelinh reviewed Oct 27, 2022

View reviewed changes

peterzhuamazon approved these changes Oct 27, 2022

View reviewed changes

gaiksaya merged commit ab94327 into opensearch-project:main Oct 27, 2022

gaiksaya deleted the npm branch October 27, 2022 23:52

gaiksaya added a commit that referenced this pull request Nov 4, 2022

Create publishToNpm library (#21)

c53f06c

* Add npm publishing lib Signed-off-by: Sayali Gaikawad <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create publishToNpm library #21

Create publishToNpm library #21

gaiksaya commented Oct 25, 2022

peterzhuamazon Oct 26, 2022

gaiksaya Oct 26, 2022

peterzhuamazon Oct 26, 2022

gaiksaya Oct 26, 2022

rishabh6788 Oct 27, 2022

peterzhuamazon Oct 27, 2022

rishabh6788 Oct 27, 2022

peterzhuamazon Oct 26, 2022

gaiksaya Oct 26, 2022

peterzhuamazon Oct 26, 2022

gaiksaya Oct 26, 2022

zelinh Oct 27, 2022

gaiksaya Oct 27, 2022

zelinh Oct 27, 2022

zelinh Oct 27, 2022

gaiksaya Oct 27, 2022

gaiksaya commented Oct 27, 2022 •

edited

Loading

Create publishToNpm library #21

Create publishToNpm library #21

Conversation

gaiksaya commented Oct 25, 2022

Description

Issues Resolved

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gaiksaya commented Oct 27, 2022 • edited Loading

gaiksaya commented Oct 27, 2022 •

edited

Loading