Skip to content

Build and publish container images for easy integration#620

Merged
dpopp07 merged 2 commits intoIBM:mainfrom
JohnStarich:feature/build-container-image
Aug 17, 2023
Merged

Build and publish container images for easy integration#620
dpopp07 merged 2 commits intoIBM:mainfrom
JohnStarich:feature/build-container-image

Conversation

@JohnStarich
Copy link
Copy Markdown
Member

@JohnStarich JohnStarich commented Aug 16, 2023

PR summary

Builds and publishes container images in CI. PR builds ensure the image continues working
for a simple case, and main/tagged builds publish new images.

Thoughts on where these images should be pushed?
I selected ibmcom/... since it looks like there's already images out there for IBM. The GitHub registry might also be worth considering.
Going with ibmdevxsdk since we have access to that one.

I thought the Containerfile idea Matthias introduced was pretty cool, but I don't think that has caught on as a standard yet and I don't want to confuse folks new to it. I changed it to Dockerfile for that reason.

PR Checklist

General checklist

Please make sure that your PR fulfills the following requirements:

  • The commit message follows the Angular Commit Message Guidelines.
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Dependencies have been updated as needed
  • .secrets.baseline updated as needed?

Checklist for adding a new validation rule:

N/A

Signed-off-by: Matthias Blümel <blaimi@blaimi.de>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Aug 16, 2023

CLA assistant check
All committers have signed the CLA.

@JohnStarich JohnStarich force-pushed the feature/build-container-image branch 2 times, most recently from c20131f to 599d7a4 Compare August 16, 2023 18:59
@JohnStarich
Copy link
Copy Markdown
Member Author

Hey all! I think this is ready for review. Before we merge, we should set up some way to log in to the appropriate registry before the docker push. I don't know which registry is preferred, so it'd be great to sort that out first.

@JohnStarich JohnStarich force-pushed the feature/build-container-image branch from 599d7a4 to bb5afac Compare August 16, 2023 19:12
Comment thread Dockerfile
@JohnStarich JohnStarich force-pushed the feature/build-container-image branch 2 times, most recently from 542c62c to 9db4ce2 Compare August 16, 2023 22:57
Copy link
Copy Markdown
Contributor

@dpopp07 dpopp07 left a comment

Choose a reason for hiding this comment

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

Looks great! I have a very small change request in the documentation but it's good otherwise. If you don't have anything else you want to do, once you've made that change, I'll approve and merge. Thanks for the PR!

Comment thread README.md Outdated

### Docker container

Run the validator with the container image by mounting your `openapi.yaml` schema document.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor thing but this language is more consistent with the rest of the readme:

Suggested change
Run the validator with the container image by mounting your `openapi.yaml` schema document.
Run the validator with the container image by mounting your API definition.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks! Updated, and should be all set. Only tricky part will be testing the deploy actually works.

@JohnStarich JohnStarich force-pushed the feature/build-container-image branch 4 times, most recently from a05d0a5 to 9f885c7 Compare August 17, 2023 16:34
@JohnStarich
Copy link
Copy Markdown
Member Author

Ok, all updated and the test deploy was successful:
image (11)

* Run test-docker in CI with a valid IBM ruleset extension
* Add docs for container image use on README
* Add deploy step to push images

Signed-off-by: John Starich <johnstarich@johnstarich.com>
@JohnStarich JohnStarich force-pushed the feature/build-container-image branch from 9f885c7 to a5dcbf6 Compare August 17, 2023 16:38
Copy link
Copy Markdown
Contributor

@dpopp07 dpopp07 left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks for your work on this

@dpopp07 dpopp07 merged commit 062b462 into IBM:main Aug 17, 2023
ibm-devx-sdk pushed a commit that referenced this pull request Aug 17, 2023
# @ibm-cloud/openapi-ruleset [1.6.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@1.5.0...@ibm-cloud/openapi-ruleset@1.6.0) (2023-08-17)

### Features

* build and publish container images for easy integration ([#620](#620)) ([062b462](062b462))
@ibm-devx-sdk
Copy link
Copy Markdown

🎉 This PR is included in version 1.6.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@ibm-devx-sdk
Copy link
Copy Markdown

🎉 This PR is included in version 1.6.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@JohnStarich JohnStarich deleted the feature/build-container-image branch August 17, 2023 18:43
@ibm-devx-sdk
Copy link
Copy Markdown

🎉 This PR is included in version 1.2.1 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants