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

Implement trigger keyword in commit message for pushing documentation to oso-api-docs #45

Open
Valefant opened this issue Jun 4, 2019 · 0 comments
Assignees
Labels
documentation All about documentation enhancement New feature or request

Comments

@Valefant
Copy link
Member

Valefant commented Jun 4, 2019

With the issue #38, we have instructed Travis to push the backend generated documentation to the oso-api-docs repository.

The only problem now is that the commit history of the oso-api-docs will get bloated, because the documentation is pushed on every backend commit. To prevent this, we want to introduce a trigger keyword [generate api-doc] in the commit messages, which then allows to push to oso-api-docs.

Here are some hints on how to do this

  • Outsource line 44-55 to a shell script called push-api-documentation.sh
  • The environment variables which are defined in line 10-15 should be passed as arguments to the script
  • Check at the beginning of the script if the string [generate api-doc] is included in the commit message. If it is then the commit to oso-api-docs should be pushed
@Valefant Valefant added enhancement New feature or request documentation All about documentation labels Jun 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation All about documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants