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

chore(docs): changes in deploy cd to push docs folder changes to docu… #3088

Conversation

Kesari3008
Copy link
Contributor

@Kesari3008 Kesari3008 commented Sep 15, 2023

COMPLETES #https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-455628

This pull request addresses

Added steps in the deploy CD pipeline to build the docs folder and push changes to the documentation branch after SDK deployment.

by making the following changes

Added GitHub action in deploy.yml file under .gihtub/worfflows folder for publishing of docs folder to the documentation branch.

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios where tested

< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >

I certified that

  • I have read and followed contributing guidelines

  • I discussed changes with code owners prior to submitting this pull request

  • I have not skipped any automated checks

  • All existing and new tests passed

  • I have updated the documentation accordingly


Make sure to have followed the contributing guidelines before submitting.

@Kesari3008 Kesari3008 added the validated If the pull request is validated for automation. label Sep 15, 2023
@Kesari3008 Kesari3008 marked this pull request as ready for review September 15, 2023 09:23
@Kesari3008 Kesari3008 requested a review from a team as a code owner September 15, 2023 09:23
Copy link
Contributor

@sreenara sreenara left a comment

Choose a reason for hiding this comment

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

Looks good to me. Perhaps we could add some test code into calling so after the merge, we can go to the samples page hosted on documentation branch and ensure that the new calling.min.js made it?

.github/workflows/deploy.yml Outdated Show resolved Hide resolved
.github/workflows/deploy.yml Outdated Show resolved Hide resolved
- name: Publish Docs Folder
run: |
git add docs/
git commit -m "chore(docs): update docs"
Copy link
Collaborator

Choose a reason for hiding this comment

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

i would add the versoin number if possible, Not sure if we want to do it here but only if webex package changes then only we need to deploy the documentation we could optimise it later too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We are not publishing the Webex package yet so we will add this later

@Kesari3008 Kesari3008 force-pushed the SPARK-455628-Pipeline-changes-to-push-to-documentation-branch branch from 7217a07 to 0d3cfec Compare September 20, 2023 06:54
Copy link
Collaborator

@Neeraj-swarnkar Neeraj-swarnkar left a comment

Choose a reason for hiding this comment

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

Looks Good.

Copy link
Contributor

@mkesavan13 mkesavan13 left a comment

Choose a reason for hiding this comment

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

Looks good to me. Approving.

However, just curious what does github.actor contain?

@Neeraj-swarnkar
Copy link
Collaborator

github.actor

@mkesavan13,
The username of the user that triggered the initial workflow run. If the workflow run is a re-run, this value may differ from github.triggering_actor. Any workflow re-runs will use the privileges of github.actor, even if the actor initiating the re-run (github.triggering_actor) has different privileges.

https://docs.github.com/en/actions/learn-github-actions/contexts

@Kesari3008 Kesari3008 merged commit 54aa423 into webex:next Sep 20, 2023
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validated If the pull request is validated for automation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants