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

fix: Adjust docs build steps in makefile to fix building all versions #10727

Merged
merged 3 commits into from
Dec 12, 2021

Conversation

coldice
Copy link
Contributor

@coldice coldice commented Dec 10, 2021

Description

Fixes the docs build process: re-enable building multiple versions. This should make the version selection work again:
image

Closes: #10228

Adjust Makefile: The issue was caused by changes on the local file system during build, which prevents the git checkout command from succeeding. These can be caused by:

  • A changed mod.sum file
  • Artifacts left over from building the previous version

This PR adjusts the makefile to ignore existing changes (git clean & git reset). The overall build process is not changed.
Please note: The actual build & deployment is triggered from the cosmos docs repository. The check-docs action in this repository only checks building the updated branch's docs.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules (not applicable)
  • included the necessary unit and integration tests (not applicable)
  • added a changelog entry to CHANGELOG.md (not applicable)
  • included comments for documenting Go code (not applicable)
  • updated the relevant documentation or specification (not applicable)
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

utACK

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

utACK, gonna merge and it should be deployed shortly

@tac0turtle tac0turtle merged commit 52f6fc2 into cosmos:master Dec 12, 2021
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.

Docs: versions other than master return 404
3 participants