ci: adding pre-release ci for oxygen sdk #992
Conversation
|
@launchdarkly/browser size report |
|
@launchdarkly/js-sdk-common size report |
|
@launchdarkly/js-client-sdk-common size report |
|
@launchdarkly/js-client-sdk size report |
joker23
force-pushed
the
szhang/sdk-1560/oxygen-sdk-ci
branch
from
b84d1b5 to
996a8f9
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| @@ -0,0 +1,70 @@ | |||
| # Creating pre-releases modules | |||
There was a problem hiding this comment.
currently I am putting this along side https://github.com/launchdarkly/js-core/blob/main/contributing/initial-package-publish.md, should I just combine them?
There was a problem hiding this comment.
I would say we combine them. Ideally link the top-level CONTRIBUTING.md to the nested doc for discoverability.
joker23
force-pushed
the
szhang/sdk-1560/oxygen-sdk-ci
branch
from
996a8f9 to
c3c133b
Compare
| build-test-shopify-oxygen: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 |
There was a problem hiding this comment.
Generally speaking we should used a SHA for these instead of a version. But it may be better to do that in its own PR as I recently did for C++.
There was a problem hiding this comment.
looks like there is also a PR against this repo #955 that might address this? Is there an easy way to get the image digest for these action images? I am having a hard time referencing them with docker pull/inspect
There was a problem hiding this comment.
There just the SHA of the associated git repo. Each action is either a repo, or in a mono-repo.
https://github.com/actions/checkout
So the SHA of the tag associated with the release.
In a mono-repo there will likely be a tag per action, such as in our case: https://github.com/launchdarkly/gh-actions/releases/tag/persistent-stores-v0.1.2
| Add a record of your new SDK package to `packages` | ||
| ``` | ||
| "PATH_TO_YOUR_PACKAGE": { | ||
| "prerelease": true, |
There was a problem hiding this comment.
I am not sure about this part. Is this part of the release-please manifest?
In our publishing process we do have a prerelease setting, which just controls the label applied, but typically that would only really matter post 1.0. In order to keep npm i @launchdarkly/whatever from installing a pre-release. But pre 1.0 that is fine and potentially desired.
There was a problem hiding this comment.
You can manually trigger this action from this branch to determine if everything is working as expected. Pre-publishing the docs won't hurt.
You would not want to do the same for the manual-publish.
There was a problem hiding this comment.
doc publish is successful https://github.com/launchdarkly/js-core/actions/runs/19338109015
This commit also made some small changes to the release please config
This PR will add initial CI for pre-releasing the LD Shopify Oxygen SDK.
Additional changes:
Note
Sets up CI, release/publish config, and docs for the new Shopify Oxygen SDK.
sdk/shopify-oxygenworkflow (.github/workflows/shopify-oxygen.yml) for build/test.packages/sdk/shopify-oxygenin manual publish workflows (manual-publish*.yml).packages/sdk/shopify-oxygento.release-please-manifest.jsonas0.0.0.release-please-config.jsonfor Shopify Oxygen (pre-1.0 settings,release-as: 0.1.0,bootstrap-sha,extra-files).tsconfig.json) and adjust packagetsconfig.ref.jsonto extend local config.typedoc.jsonfor docs generation inpackages/sdk/shopify-oxygen.contributing/publishing.mdand link fromCONTRIBUTING.md; fix "Dependencies" heading typo.Written by Cursor Bugbot for commit 9a544cc. This will update automatically on new commits. Configure here.