You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: mark page upload commands as stable, update migration guide (#1287)
| 🚥 Resolves RM-13226, RM-13227 |
| :------------------- |
## 🧰 Changes
- [x] marks all page upload commands as stable
- [x] updates migration guide to reflect command availability
- [x] updates command descriptions to reflect new frontmatter format
(will require links to the docs in
#1284)
## 🧬 QA & Testing
confirmed that all of the help screens and warnings are updated
accordingly!
Copy file name to clipboardExpand all lines: README.md
+25-6Lines changed: 25 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ With `rdme`, you can manage your API definition (we support [OpenAPI](https://sp
20
20
Not using ReadMe for your docs? No worries. `rdme` has a variety of tools to help you identify issues with your API definition — no ReadMe account required.
21
21
22
22
> [!NOTE]
23
-
> If you're using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored), you'll want to use `rdme@10` or later. If you're **not** using ReadMe Refactored, you'll want to use `rdme@9`. More info can be found in our [migration guide](https://github.com/readmeio/rdme/blob/v10/documentation/migration-guide.md).
23
+
> If you're using [ReadMe Refactored](https://docs.readme.com/main/docs/migration), you'll want to use `rdme@10` or later. If you're **not** using ReadMe Refactored, you'll want to use `rdme@9`. More info can be found in our [migration guide](https://github.com/readmeio/rdme/blob/v10/documentation/migration-guide.md).
24
24
25
25
# Table of Contents
26
26
@@ -142,18 +142,33 @@ rdme login
142
142
143
143
# GitHub Actions Configuration
144
144
145
-
> [!NOTE]
146
-
> For a full GitHub Workflow file example and additional information on GitHub Actions usage, check out [our docs](https://docs.readme.com/docs/rdme#github-actions-usage).
145
+
`rdme` has a thin wrapper that allows the CLI to be used as a proper action in a GitHub Actions workflow. For example, say you wanted to run `rdme openapi validate petstore.json` in a GitHub Actions environment. Here's what the corresponding steps would look like in a GitHub Actions workflow file:
146
+
147
+
```yml
148
+
# Required in order for the GitHub Action to access your repo's contents
149
+
- uses: actions/checkout@v4
150
+
151
+
# Runs the `rdme openapi validate petstore.json` command with the root directory being your repo
152
+
- uses: readmeio/rdme@v10
153
+
with:
154
+
rdme: openapi validate petstore.json
155
+
```
156
+
157
+
For more information on getting started with GitHub Actions, check out [our docs](https://docs.readme.com/main/docs/rdme#github-actions-usage).
158
+
159
+
<!-- (commenting all of this out until we add back this flag to all of the relevant commands)
147
160
148
161
For usage in [GitHub Actions](https://docs.github.com/actions), you can create a new GitHub Actions workflow file by installing the CLI on your local machine and running the the command you wish to run in GitHub Actions, along with the `--github` flag. For example:
149
162
150
163
```sh
151
164
rdme openapi validate --github
152
165
```
153
166
154
-
This will run through the `openapi` command, ask you a few quick questions, and then automatically create a fully functional GitHub Actions workflow file for you. 🪄
167
+
This will run through the `openapi validate` command, ask you a few quick questions, and then automatically create a fully functional GitHub Actions workflow file for you. 🪄
155
168
156
-
You can see examples featuring the latest version in [our docs](https://docs.readme.com/docs/rdme#github-actions-examples). We recommend [configuring Dependabot to keep your actions up-to-date](https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot).
169
+
You can see examples featuring the latest version in [our docs](https://docs.readme.com/main/docs/rdme#github-actions-examples). We recommend [configuring Dependabot to keep your actions up-to-date](https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot).
170
+
171
+
-->
157
172
158
173
<!--
159
174
This section is autogenerated using `oclif` and is regenerated with every release.
@@ -170,15 +185,19 @@ npm run build && npm run build:docs
* [`rdme changelog`](documentation/commands/changelog.md) - Upload Markdown files to the Changelog section of your ReadMe project.
189
+
* [`rdme custompages`](documentation/commands/custompages.md) - Upload Markdown or HTML files to the Custom Pages section of your ReadMe project.
190
+
* [`rdme docs`](documentation/commands/docs.md) - Upload Markdown files to the Guides section of your ReadMe project.
173
191
* [`rdme help`](documentation/commands/help.md) - Display help for rdme.
174
192
* [`rdme login`](documentation/commands/login.md) - Login to a ReadMe project.
175
193
* [`rdme logout`](documentation/commands/logout.md) - Logs the currently authenticated user out of ReadMe.
176
194
* [`rdme openapi`](documentation/commands/openapi.md) - Manage your API definition (e.g., syncing, validation, analysis, conversion, etc.). Supports OpenAPI, Swagger, and Postman collections, in either JSON or YAML formats.
177
195
* [`rdme plugins`](documentation/commands/plugins.md) - List installed plugins.
196
+
* [`rdme reference`](documentation/commands/reference.md) - Upload Markdown files to the Reference section of your ReadMe project.
178
197
* [`rdme whoami`](documentation/commands/whoami.md) - Displays the current user and project authenticated with ReadMe.
179
198
180
199
<!-- commandsstop -->
181
200
<!-- prettier-ignore-end -->
182
201
183
202
> [!IMPORTANT]
184
-
> You'll notice that several previous `rdme` commands are no longer present. That's because this version is for projects that use [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored) and [bi-directional syncing](https://docs.readme.com/main/docs/bi-directional-sync) is the recommended approach for most workflows previously managed via `rdme`. See more in [our migration guide](./documentation/migration-guide.md).
203
+
> You'll notice that several previous `rdme` commands are no longer present. That's because this version is for projects that use [ReadMe Refactored](https://docs.readme.com/main/docs/migration) and [bi-directional syncing](https://docs.readme.com/main/docs/bi-directional-sync) is the recommended approach for most workflows previously managed via `rdme`. See more in [our migration guide](./documentation/migration-guide.md).
0 commit comments