@team-supercharge/oasg 16.4.1 → 16.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,7 @@ Design APIs in OpenAPI 3.0 format, lint them, and generate client/server package
|
|
|
8
8
|
* [Create `.config.json`](#create-config.json)
|
|
9
9
|
* [Configure Linter](#configure-linter)
|
|
10
10
|
* [Use with Docker](#use-with-docker)
|
|
11
|
+
* [Use with GitLab CI](#use-with-gitlab-ci)
|
|
11
12
|
* [Version Overview](#version-overview)
|
|
12
13
|
* [Usage](#usage)
|
|
13
14
|
* [Linter Rules](#linter-rules)
|
|
@@ -101,6 +102,26 @@ swaggerlint:
|
|
|
101
102
|
|
|
102
103
|
> If no other dependency is needed for the API project being built, there is no need to run any `npm install` or `npm ci` commands before invoking `oasg`
|
|
103
104
|
|
|
105
|
+
## Use with GitLab CI
|
|
106
|
+
|
|
107
|
+
Built on the [Docker](#use-with-docker) setup, a set of predefined templates are readily available for GitLab CI.
|
|
108
|
+
|
|
109
|
+
When your project is hosted on gitlab.com __OASg__ should always be included in your projects `.gitlab-ci.yml` by explicitly specifying a version, like this:
|
|
110
|
+
|
|
111
|
+
```yaml
|
|
112
|
+
include:
|
|
113
|
+
- project: team-supercharge/oasg
|
|
114
|
+
file: gitlab-ci-templates.yml
|
|
115
|
+
ref: <version tag>
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
when your project is hosted on a self-managed GitLab instance use the following snippet:
|
|
119
|
+
|
|
120
|
+
```yaml
|
|
121
|
+
include:
|
|
122
|
+
- remote: https://gitlab.com/team-supercharge/oasg/raw/<version-tag>/gitlab-ci-templates.yml
|
|
123
|
+
```
|
|
124
|
+
|
|
104
125
|
---
|
|
105
126
|
|
|
106
127
|
# Version Overview
|
package/package.json
CHANGED