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

[FEATURE] Adds github action to generate doc #1522

Merged
merged 2 commits into from
Apr 13, 2020

Conversation

anshulguleria
Copy link
Contributor

@anshulguleria anshulguleria commented Apr 10, 2020

Added github action install dependencies required to generate
documentation and then run the documentation generator.

As a final step publish the changes to gh-pages branch which will be
the source for github documentation.

Adds badge for doc-generator github action

closes: #1494

Summary

Test plan

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Added github action install dependencies required to generate
documentation and then run the documentation generator.

As a final step publish the changes to `gh-pages` branch which will be
the source for github documentation.

Adds badge for doc-generator github action

closes: kulshekhar#1494
@ahnpnl
Copy link
Collaborator

ahnpnl commented Apr 10, 2020

Just side information, since we start using github actions, I think we can do a POC for #664 on github actions CI against Travis for our CI

@anshulguleria
Copy link
Contributor Author

@ahnpnl Sure. I recently did a similar thing in one of my packages.

https://github.com/amzn/git-commit-template/blob/master/.github/workflows/npmpublish.yml

Let me know that workflow is fine. I can add a similar thing for this.

This is how my workflow happens: https://github.com/amzn/git-commit-template/blob/master/SETUP.md#releasing-the-changes

@ahnpnl
Copy link
Collaborator

ahnpnl commented Apr 10, 2020

@ahnpnl Sure. I recently did a similar thing in one of my packages.

https://github.com/amzn/git-commit-template/blob/master/.github/workflows/npmpublish.yml

Let me know that workflow is fine. I can add a similar thing for this.

This is how my workflow happens: https://github.com/amzn/git-commit-template/blob/master/SETUP.md#releasing-the-changes

@kulshekhar this is something you would love
@anshulguleria I think it is also possible to create a release in GitHub release page with this too, probably with https://github.com/release-it/release-it ?

@coveralls
Copy link

Pull Request Test Coverage Report for Build 4407

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.944%

Totals Coverage Status
Change from base Build 4406: 0.0%
Covered Lines: 1160
Relevant Lines: 1195

💛 - Coveralls

Copy link
Owner

@kulshekhar kulshekhar left a comment

Choose a reason for hiding this comment

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

Thanks @anshulguleria !

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.

Is documentation site down?
4 participants