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

[circleci] Improve python docs deployment strategy #615

Merged
merged 1 commit into from
Sep 25, 2018

Conversation

labbati
Copy link
Member

@labbati labbati commented Sep 24, 2018

Problems we had:

  • the only way we had to release docs was to push a branch with a release tag
  • when we wanted to release docs we had to re-run all tests, which was
    not desired.

What this PR changes:

  • Now docs doesn't require tests to be run
  • Now docs do not require a release, can be published at any time
  • In order to publish docs just add a tag 'docs' and push it
  • Docs for release tags 'vx.x.x' are still built and deployed
  • A browsable preview of the docs is available in the build step's artifacts
  • The preview can be inspected before manually approving the deploy to S3.

@labbati labbati added this to the 0.15.0 milestone Sep 24, 2018
@labbati labbati force-pushed the labbati/django-cache-service branch 2 times, most recently from 5d8f62a to 7ff1585 Compare September 25, 2018 07:51
@labbati labbati force-pushed the labbati/ci-deploy-doc branch 6 times, most recently from fa6e98b to 60f09c0 Compare September 25, 2018 12:13
Problems we had:
- the only way we had to release docs was to push a branch with a release tag
- when we wanted to release docs we had to re-run all tests, which was
  not desired.

What this commit changes:
- Now docs doesn't require tests to be run
- Now docs do not require a release, can be published at any time
- In order to publish docs just add a tag 'docs' and push it
- Docs for release tags 'vx.x.x' are still built and deployed
- A browsable preview of the docs is available in the build step's
artifacts
- The preview can be inspected before approving the manual deploy to S3.
@labbati labbati changed the base branch from labbati/django-cache-service to master September 25, 2018 12:48
@labbati labbati changed the title [circleci] On master, hold deploy_jobs for explicit manual approval before publish docs [circleci] Improve python docs deployment strategy Sep 25, 2018
@labbati labbati merged commit c720940 into master Sep 25, 2018
@labbati labbati deleted the labbati/ci-deploy-doc branch September 25, 2018 14:38
@labbati labbati modified the milestones: 0.15.0, 0.14.1 Sep 25, 2018
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.

None yet

2 participants