Skip to content

Merge docs/3.0.0 with develop and Add CNAME to publish-docs (#319)#336

Merged
jeffngo merged 1 commit intodelphix:developfrom
jeffngo:docs/test
Feb 9, 2021
Merged

Merge docs/3.0.0 with develop and Add CNAME to publish-docs (#319)#336
jeffngo merged 1 commit intodelphix:developfrom
jeffngo:docs/test

Conversation

@jeffngo
Copy link
Contributor

@jeffngo jeffngo commented Feb 8, 2021

Virtualization SDK Docs - Virtual Source Initialize (#316)

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build was run locally and any changes were pushed
  • Lint has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):
    Add CNAME to publish-docs when pushing to delphix/virtualization-sdk

What is the current behavior?

Issue Number: 319

  1. Any changes made to the github actions itself does not trigger a new run of the action.
  2. The CNAME file does not get created when pushing to delphix/virtualization-sdk repo.

What is the new behavior?

When the release lead pushes to a docs/** branch, kick off github actions if any changes were made to the .yml file itself (to test the new code in the github action). In addition, only create a CNAME file when publishing the docs to gh-pages to the delphix/virtualization repository. The reason for this is because the CNAME file contains the URL for our documentation (developer.delphix.com) and pushing the CNAME file will fail the github action since the domain is already in use.

Does this introduce a breaking change?

  • Yes
  • No

Other information

Virtualization SDK Docs - Virtual Source Initialize (delphix#316)
@jeffngo jeffngo added this to the VSDK Sprint 1/28-2/18 milestone Feb 8, 2021
@jeffngo jeffngo self-assigned this Feb 8, 2021
@jeffngo jeffngo linked an issue Feb 8, 2021 that may be closed by this pull request
@jeffngo jeffngo merged commit f2c9bfe into delphix:develop Feb 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

Create additional pipeline step to create CNAME record on pushes to docs

3 participants