Skip to content

Commit

Permalink
feat!: remove all deprecated commands (#1104)
Browse files Browse the repository at this point in the history
## 🧰 Changes

Removes the commands that we've deprecated in favor of bidirectional
syncing.

Will be merging this PR into #1113
to collect all breaking changes as part of this PR!

## 🧬 QA & Testing

do tests still pass?

## ⚠️ Breaking Changes

BREAKING CHANGE: `categories`, `custompages`, `docs` and `versions` have
now been removed. Please use a bidirectional syncing workflow instead.
Read more in [our migration
guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
  • Loading branch information
kanadgupta authored Dec 10, 2024
1 parent 3e20d1c commit 817b8d8
Show file tree
Hide file tree
Showing 46 changed files with 34 additions and 5,290 deletions.
33 changes: 5 additions & 28 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
name: Sync `documentation` directory to ReadMe

# Run workflow for every push
on: push
on:
push:
branches:
- main

jobs:
sync:
Expand Down Expand Up @@ -40,33 +43,7 @@ jobs:
regex: false
include: documentation/*

# Since this workflow file is in the `rdme` repository itself,
# we need to test the GitHub Action using the current commit.
# This step builds the `rdme` action code so we can do that.
#
# This step is not required for syncing your docs to ReadMe!
- name: Rebuild GitHub Action for testing purposes
run: npm run build:gha

# And finally, with our updated documentation,
# we run the `rdme` GitHub Action to sync the Markdown file
# in the `documentation` directory.
# Here's the page we're syncing: https://docs.readme.com/docs/rdme

# First we're going to perform a dry run of syncing process.
# We do this on every push to ensure that an actual sync will work properly
- name: Sync docs to ReadMe (dry run)
uses: ./
with:
rdme: docs ./documentation --key=${{ secrets.README_DEVELOPERS_API_KEY }} --version=${{ vars.README_DEVELOPERS_MAIN_VERSION }} --dryRun

# And finally, we perform an actual sync to ReadMe if we're on the main branch
- name: Sync docs to ReadMe
if: github.event_name == 'push' && github.event.ref == 'refs/heads/main'
# We use the `main` branch as ref for GitHub Action
# This is NOT recommended, as it can break your workflows without notice!
# We recommend specifying a fixed version, i.e. @8.0.0
# Docs: https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#example-using-versioned-actions
uses: readmeio/rdme@main
uses: readmeio/rdme@v9
with:
rdme: docs ./documentation --key=${{ secrets.README_DEVELOPERS_API_KEY }} --version=${{ vars.README_DEVELOPERS_MAIN_VERSION }}
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,16 +167,15 @@ npm run build && npm run build:docs
# Command Topics

* [`rdme autocomplete`](documentation/commands/autocomplete.md) - Display autocomplete installation instructions.
* [`rdme categories`](documentation/commands/categories.md) - List or create categories in your ReadMe developer hub.
* [`rdme changelogs`](documentation/commands/changelogs.md) - Sync Markdown files to your ReadMe project as Changelog posts.
* [`rdme custompages`](documentation/commands/custompages.md) - Sync Markdown/HTML files to your ReadMe project as Custom Pages.
* [`rdme docs`](documentation/commands/docs.md) - Sync or prune Guides pages in your ReadMe developer hub.
* [`rdme help`](documentation/commands/help.md) - Display help for rdme.
* [`rdme login`](documentation/commands/login.md) - Login to a ReadMe project.
* [`rdme logout`](documentation/commands/logout.md) - Logs the currently authenticated user out of ReadMe.
* [`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.
* [`rdme versions`](documentation/commands/versions.md) - Manage your documentation versions.
* [`rdme whoami`](documentation/commands/whoami.md) - Displays the current user and project authenticated with ReadMe.

<!-- commandsstop -->
<!-- prettier-ignore-end -->

> [!IMPORTANT]
> 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).
161 changes: 0 additions & 161 deletions __tests__/commands/categories/create.test.ts

This file was deleted.

76 changes: 0 additions & 76 deletions __tests__/commands/categories/index.test.ts

This file was deleted.

Loading

0 comments on commit 817b8d8

Please sign in to comment.