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

Sync built docs in master to s3 #5941

Merged
merged 2 commits into from Apr 11, 2018

Conversation

Projects
None yet
5 participants
@bcardiff
Member

bcardiff commented Apr 11, 2018

Fix #5934 .

For every commit in master, the built docs will be published at https://crystal-lang.org/api/master

@bcardiff bcardiff changed the title from Sync built docs in to s3 to Sync built docs in master to s3 Apr 11, 2018

@bcardiff bcardiff force-pushed the ci/docs branch from ddccd69 to 25a797c Apr 11, 2018

@ghost

This comment has been minimized.

ghost commented Apr 11, 2018

ty, helps a lot

-e AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} \
-e AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} \
mesosphere/aws-cli \
s3 sync /docs/ s3://crystal-api/api/master

This comment has been minimized.

@straight-shoota

straight-shoota Apr 11, 2018

Contributor

Add --delete flag to remove files that are no longer in the genetated docs.

This comment has been minimized.

@bcardiff

bcardiff Apr 11, 2018

Member

Good catch. Adding it (and checkin the output in the next commit with a dryrun, will remove shortly)

@straight-shoota

This comment has been minimized.

Contributor

straight-shoota commented Apr 11, 2018

Awesome to get this implemented!

Why are there additional prepare jobs showing up in the CI results?

@bcardiff bcardiff force-pushed the ci/docs branch from 25a797c to 7aa73b8 Apr 11, 2018

@bcardiff

This comment has been minimized.

Member

bcardiff commented Apr 11, 2018

@straight-shoota Branches with ci word in the branch name stress the whole release process. I should've pick other branch name instead of ci/docs. That's the reason why the extra build checks appear.

@bcardiff bcardiff force-pushed the ci/docs branch from 7aa73b8 to 5633979 Apr 11, 2018

@bcardiff

This comment has been minimized.

Member

bcardiff commented Apr 11, 2018

Ok, things ready here. When merged the following sync will be performedhttps://circleci.com/gh/crystal-lang/crystal/5003

The unreferenced revision.txt is will hold the exact SHA1 published for double checking.

@jhass

jhass approved these changes Apr 11, 2018

Persist to worspace only in linux64 specs
Otherwise maintenance fails because all test_* workspace are restored
@@ -22,7 +18,15 @@ jobs:
TRAVIS_OS_NAME: linux
ARCH: x86_64
ARCH_CMD: linux64
steps: *ci_steps
steps:

This comment has been minimized.

@Sija

Sija Apr 11, 2018

Contributor

I think it could be simplified to:

steps:
  <<: *ci_steps
  - persist_to_workspace:
    root: .
    paths:
      - docs

This comment has been minimized.

@bcardiff

bcardiff Apr 11, 2018

Member

I wish, but yaml does not support merging arrays AFAIK.

@RX14

RX14 approved these changes Apr 11, 2018

@RX14 RX14 merged commit 8dd6f54 into master Apr 11, 2018

13 checks passed

ci/circleci: dist_artifacts Your tests passed on CircleCI!
Details
ci/circleci: dist_darwin Your tests passed on CircleCI!
Details
ci/circleci: dist_docker Your tests passed on CircleCI!
Details
ci/circleci: dist_docs Your tests passed on CircleCI!
Details
ci/circleci: dist_linux Your tests passed on CircleCI!
Details
ci/circleci: prepare_common Your tests passed on CircleCI!
Details
ci/circleci: prepare_maintenance Your tests passed on CircleCI!
Details
ci/circleci: publish_docker Your tests passed on CircleCI!
Details
ci/circleci: test_darwin Your tests passed on CircleCI!
Details
ci/circleci: test_linux Your tests passed on CircleCI!
Details
ci/circleci: test_linux32 Your tests passed on CircleCI!
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@RX14 RX14 added this to the Next milestone Apr 11, 2018

@asterite asterite deleted the ci/docs branch Apr 27, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment