Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removes Stoplight API docu auto build orb. #4311

Merged
merged 1 commit into from
Mar 22, 2022

Conversation

wintermeyer
Copy link
Contributor

Stoplight changed its system to build the API documentation.

We can't trigger the build as we used to but on the bright side circleci can now watch the GitHub repository and triggers the build by itself. That is already configured (kudos to @kennyadsl). This PR removes the old .circleci/config.yaml configuration for the stoplight/push and stoplight/build.

Warning: I did run circleci config validate but other than that I had no way to test this.

To-Do

  • Remove $STOPLIGHT_GIT_TOKEN and $STOPLIGHT_API_TOKEN as env variables in the CI.

Checklist:

  • I have followed Pull Request guidelines
  • I have added a detailed description into each commit message
  • I have updated Guides and README accordingly to this change (if needed)
  • I have added tests to cover this change (if needed)
  • I have attached screenshots to this PR for visual changes (if needed)

Copy link
Member

@kennyadsl kennyadsl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Stefan!

@waiting-for-dev waiting-for-dev merged commit 00b7f64 into solidusio:master Mar 22, 2022
@waiting-for-dev waiting-for-dev deleted the remove_stoplight_build branch March 22, 2022 03:58
@kennyadsl
Copy link
Member

I backported this change in v2.11, v3.0 and v3.1 to avoid trying to sync when we make changes to those branches.

On a side note, this sync is still enabled (for 3.0 and 3.1 branches) and configured directly in Stoplight. It will listen via webhooks to any change in these branches and update the REST API documentation for that specific version accordingly.

Users will be able to choose the right version with the dedicated menu:

CleanShot 2022-05-11 at 12 43 36@2x.

The last released version will be the default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants