Skip to content

Move docs deployment from Travis CI to GitHub Actions#1759

Merged
jonahtanjz merged 5 commits into
MarkBind:masterfrom
tlylt:update-deploy
Feb 13, 2022
Merged

Move docs deployment from Travis CI to GitHub Actions#1759
jonahtanjz merged 5 commits into
MarkBind:masterfrom
tlylt:update-deploy

Conversation

@tlylt

@tlylt tlylt commented Feb 11, 2022

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:
    DevOps

Overview of changes:
Fixes #1386

  • Delete Travis CI config file
    • Might need one of the senior devs to disable build settings on Travis (not sure)
  • Update GitHub Actions workflow to deploy docs
    • (same as previous flow)
    • deploy DG on every commit to master
    • deploy UG on release, this is done when the tag of the new version is pushed
  • Consolidate some build/deploy commands into package.json
  • Update devGuide to use the new npm run build:ug etc commands

Anything you'd like to highlight / discuss:
Not able to test this locally, but I have created a sample repo to test the CI logic, which seems to be correct. Some intended runs as follows:

Testing instructions:
See above. Reference: Workflow syntax

Proposed commit message: (wrap lines at 72 characters)
Move docs deployment from Travis CI to GitHub Actions

There is a change to Travis' pricing model.

Let's move docs deployment into GitHub Actions and remove
the usage of Travis from our CI processes.

This will potentially remove any costs incurred when using Travis.


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@tlylt tlylt requested a review from ong6 February 11, 2022 11:29

@ong6 ong6 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice work! The changes so far look good! I don't think this exactly fixes the issue of #1386 but will certainly help reduce the build minutes with Travis. I think I'll leave it to one of the senior dev's to approve this PR instead.

ong6
ong6 previously approved these changes Feb 11, 2022
@ong6 ong6 dismissed their stale review February 11, 2022 15:04

approved wronly

@jonahtanjz jonahtanjz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great job @tlylt 👍 Just a minor suggestion, other than that the rest looks good :)

Might need one of the senior devs to disable build settings on Travis (not sure)

Yup will need @ang-zeyu help to turn off Travis integration.

Comment thread .github/workflows/ci.yml Outdated
Co-authored-by: Jonah Tan <47470981+jonahtanjz@users.noreply.github.com>

@jonahtanjz jonahtanjz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @tlylt

One last thing, I noticed that our README file still has the build status badge pointing to Travis. Will need to update this as well :)

@tlylt

tlylt commented Feb 12, 2022

Copy link
Copy Markdown
Contributor Author

Thanks @tlylt

One last thing, I noticed that our README file still has the build status badge pointing to Travis. Will need to update this as well :)

Yup sorry forgot about it, will change accordingly.

@jonahtanjz jonahtanjz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍

@jonahtanjz jonahtanjz added this to the 4.0 milestone Feb 12, 2022
@jonahtanjz jonahtanjz merged commit 2dd7ab1 into MarkBind:master Feb 13, 2022
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.

Move all CI / CD to github actions

3 participants