Skip to content
This repository has been archived by the owner on Apr 24, 2024. It is now read-only.

assert documentation exists when mapboxjs version is bumped #1309

Merged
merged 1 commit into from
Oct 18, 2019

Conversation

katydecorah
Copy link
Contributor

When mapboxjs is updated in _config.publisher-production.yml the documentation for that version must exist, otherwise, the production site will redirect to the 404 page. This is because the Mapbox.js landing page redirects to the latest version of the documentation.

This PR adds a test to verify that the documentation folder exists for the current mapboxjs version in _config.publisher-production.yml. If the folder does not exist, the tests will fail.

cc @whyvez @alulsh

@katydecorah katydecorah requested a review from danswick October 17, 2019 17:46
@whyvez
Copy link
Contributor

whyvez commented Oct 17, 2019

@katydecorah When will this test run? I don't think tests are run in Travis. Running tests locally is also hard because of the required dependencies (i.e. phantomjs). I think tests could fail and nobody would notice.

@danswick
Copy link
Contributor

@whyvez the test was run on this PR https://travis-ci.org/mapbox/mapbox.js/builds/599273048#L520. I think the idea here is that docs should be created first, then version numbers bumped.

@whyvez
Copy link
Contributor

whyvez commented Oct 17, 2019

@danswick Right! I forgot about the implicit npm test in Travis. When you say version bumped, you mean the version in the _config*.yml? If so why? I created an automated script here and would like to get it right in there.

@katydecorah
Copy link
Contributor Author

The automated script in #1308 is awesome. I would still like to include this test as added assurance that documentation exists when the version is bumped in the publisher config to prevent broken pages - this is critical to documentation's operational excellence.

Copy link
Contributor

@danswick danswick left a comment

Choose a reason for hiding this comment

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

This test looks great, @katydecorah!

@katydecorah katydecorah merged commit 6e7c408 into publisher-production Oct 18, 2019
@katydecorah katydecorah deleted the test-config-bump branch October 18, 2019 13:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants