Skip to content

Commit

Permalink
Add warning for gitlab workflow target branch
Browse files Browse the repository at this point in the history
  • Loading branch information
jordojordo committed Jan 9, 2025
1 parent 5d31683 commit 66763c6
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docusaurus/docs/extensions/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,29 @@ When building an extension that will be housed in a GitLab repository or hosted
This pipeline will build an ECI and publish it to container registry (`registry.gitlab.com` by default) to allow for importing into Rancher Manager.
The actual pipeline jobs are defined in the [Dashboard repo](https://github.com/rancher/dashboard/blob/master/.gitlab/workflows/build-extension-catalog.gitlab-ci.yml) to allow for proper versioning and to apply any updates to the pipeline without any additional work from the Extension developer.

> **_WARNING:_** Ensure the branch of `rancher/dashboard` in the `remote` url containing the reusable workflow matches the release version of your `@rancher/shell` npm dependency. For example:
> - If building for the latest version of Rancher:
> ```yaml
> #.gitlab-ci.yml
> ...
> include:
> - remote: 'https://raw.githubusercontent.com/rancher/dashboard/master/shell/scripts/.gitlab/workflows/build-extension-catalog.gitlab-ci.yml'
> ```
> - If building for Rancher `v2.9`:
> ```yaml
> #.gitlab-ci.yml
> ...
> include:
> - remote: 'https://raw.githubusercontent.com/rancher/dashboard/release-2.9/shell/scripts/.gitlab/workflows/build-extension-catalog.gitlab-ci.yml'
> ```
> - If building for Rancher `v2.8`:
> ```yaml
> #.gitlab-ci.yml
> ...
> include:
> - remote: 'https://raw.githubusercontent.com/rancher/dashboard/release-2.8/shell/scripts/.gitlab/workflows/build-extension-catalog.gitlab-ci.yml'
> ```

### Pipeline Configuration

There are a few pipeline configuration options, mostly tied to the container registry:
Expand Down
16 changes: 16 additions & 0 deletions docusaurus/extensions_versioned_docs/version-v2/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,22 @@ When building an extension that will be housed in a GitLab repository or hosted
This pipeline will build an ECI and publish it to container registry (`registry.gitlab.com` by default) to allow for importing into Rancher Manager.
The actual pipeline jobs are defined in the [Dashboard repo](https://github.com/rancher/dashboard/blob/master/.gitlab/workflows/build-extension-catalog.gitlab-ci.yml) to allow for proper versioning and to apply any updates to the pipeline without any additional work from the Extension developer.

> **_WARNING:_** Ensure the branch of `rancher/dashboard` in the `remote` url containing the reusable workflow matches the release version of your `@rancher/shell` npm dependency. For example:
> - If building for Rancher `v2.9`:
> ```yaml
> #.gitlab-ci.yml
> ...
> include:
> - remote: 'https://raw.githubusercontent.com/rancher/dashboard/release-2.9/shell/scripts/.gitlab/workflows/build-extension-catalog.gitlab-ci.yml'
> ```
> - If building for Rancher `v2.8`:
> ```yaml
> #.gitlab-ci.yml
> ...
> include:
> - remote: 'https://raw.githubusercontent.com/rancher/dashboard/release-2.8/shell/scripts/.gitlab/workflows/build-extension-catalog.gitlab-ci.yml'
> ```

### Pipeline Configuration

There are a few pipeline configuration options, mostly tied to the container registry:
Expand Down

0 comments on commit 66763c6

Please sign in to comment.