update(no-ticket): Update CircleCi docs to reflect new v2.0.0 release#381
update(no-ticket): Update CircleCi docs to reflect new v2.0.0 release#381BartoszBlizniak wants to merge 1 commit intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates documentation to reflect Cloudsmith CircleCI Orb v2.0.0, including new OIDC-focused guidance and updated configuration examples.
Changes:
- Bumps orb version references to
cloudsmith/cloudsmith@2.0.0and updates CircleCI examples accordingly. - Adds guidance recommending OIDC +
cloudsmith/install-cli+ direct CLI invocation instead ofcloudsmith/publish. - Updates the OpenID Connect docs with an orb-based CircleCI example using
authenticate-with-oidc.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
src/content/integrations/integrating-with-circleci.mdx |
Updates orb version and expands CircleCI examples for OIDC + CLI workflows (but currently contains invalid CircleCI job syntax in examples). |
src/content/authentication/openid-connect.mdx |
Updates CircleCI OIDC example to orb v2.0.0 and shows CLI-based publish flow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| jobs: | ||
| publish: | ||
| executor: circleci/python:3.7 | ||
| executor: cimg/python:3.10 |
There was a problem hiding this comment.
The CircleCI job examples use executor: cimg/python:3.10, but cimg/python:3.10 is a Docker image name, not an executor. As written, this config won’t run unless an executor with that name is defined. Use a docker: stanza with image: cimg/python:3.10 (or define a named executor) instead.
| executor: cimg/python:3.10 | |
| docker: | |
| - image: cimg/python:3.10 |
| jobs: | ||
| publish: | ||
| executor: circleci/python:3.7 | ||
| executor: cimg/python:3.10 | ||
| steps: |
There was a problem hiding this comment.
Same issue here: executor: cimg/python:3.10 is not valid unless an executor is defined with that name. Switch to a docker: image stanza (or define a named executor) so the example is copy/paste runnable.
| <Note variant="note"> | ||
| The `cloudsmith/publish` command is deprecated and will be removed in a future major version. The recommended approach is to use `cloudsmith/install-cli` and `cloudsmith/authenticate-with-oidc` (or `cloudsmith/ensure-api-key`), then invoke the Cloudsmith CLI directly in your `run` steps. See the [Manual integration](#manual-integration) section below. | ||
| </Note> |
There was a problem hiding this comment.
The deprecation note says cloudsmith/publish is deprecated, but the very next example still uses cloudsmith/publish without labeling it as a legacy approach. This is likely to confuse readers—either update the example to the recommended CLI approach or clearly mark the snippet as legacy/deprecated usage.
| ``` | ||
|
|
||
| Putting this all together, we end up with a `.circleci/config.yaml` file which looks like so: | ||
| The recommended approach is to combine OIDC authentication with the CLI and invoke it directly in your `run` steps. Putting this all together, we end up with a `.circleci/config.yaml` file which looks like so: |
There was a problem hiding this comment.
This sentence switches the config filename to .circleci/config.yaml, but earlier the page uses .circleci/config.yml. Pick one and keep it consistent (CircleCI docs typically use config.yml).
| The recommended approach is to combine OIDC authentication with the CLI and invoke it directly in your `run` steps. Putting this all together, we end up with a `.circleci/config.yaml` file which looks like so: | |
| The recommended approach is to combine OIDC authentication with the CLI and invoke it directly in your `run` steps. Putting this all together, we end up with a `.circleci/config.yml` file which looks like so: |
| jobs: | ||
| publish: | ||
| executor: circleci/python:3.7 | ||
| executor: cimg/python:3.10 |
There was a problem hiding this comment.
Same CircleCI config issue in the manual integration example: executor: cimg/python:3.10 refers to an image, not an executor. Use a docker: image stanza (or define an executor) so the example is valid.
| executor: cimg/python:3.10 | |
| docker: | |
| - image: cimg/python:3.10 |
| name: Build and publish Python package | ||
| command: | | ||
| pip install build | ||
| python -m build --wheel | ||
| cloudsmith push python my-org/my-repo dist/*.whl | ||
| ``` |
There was a problem hiding this comment.
Within this page the repository slug examples vary between myorg/myrepo and my-org/my-repo. Using a single consistent placeholder format will reduce copy/paste errors for readers.
This PR updates our documentation to reflect the new release of
v2.0.0of Cloudsmith Orb which brings OIDC to life and some quality of life improvements.