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

feat(deploy-docs): add new input variable to select mkdocs-requirements #164

Conversation

takam5f2
Copy link
Contributor

@takam5f2 takam5f2 commented Jun 9, 2022

Signed-off-by: Takayuki AKAMINE [email protected]

Description

I'd like to update deploy-docs to give customized mkdocs-requirements.txt. The default requirements file ${GITHUB_ACTION_PATH}/mkdocs-requirements.txt} will be used if users don't describe any input file.

I've tested this change with two patterns; using default mkdocs-requirements.txt and using customized one.

  • Default requirements.txt : ${GITHUB_ACTION_PATH}/mkdocs-requirements.txt} (like CARET_doc)

    • pip3 install command was executed with ${GITHUB_ACTION_PATH}/mkdocs-requirements.txt}
    • All packages are installed as expected (log)
  • Customized requirements.txt : ./mkdocs-requirements.txt (like CARET_analyze)

    • pip3 install command was executed with ./mkdocs-requirements.txt
    • All packages were installed as expected (log)
    • deploy-docs is failed due to another reason not related to this PR

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@takam5f2
Copy link
Contributor Author

takam5f2 commented Jun 9, 2022

This PR is related with #163.
I changed deploy-docs according to feedback given in the PR #163.

@takam5f2 takam5f2 self-assigned this Jun 9, 2022
@takam5f2
Copy link
Contributor Author

takam5f2 commented Jun 9, 2022

@kenji-miyake
Sorry, but I'd like change status of this PR in draft. I found that I have to update documentation as well.

@takam5f2 takam5f2 marked this pull request as draft June 9, 2022 08:06
@takam5f2 takam5f2 marked this pull request as ready for review June 9, 2022 08:18
deploy-docs/README.md Outdated Show resolved Hide resolved
@takam5f2
Copy link
Contributor Author

takam5f2 commented Jun 9, 2022

@kenji-miyake
Thank you for giving comments, and it is exactly reasonable. I accepted your comments.

@kenji-miyake
Copy link
Contributor

@takam5f2
Copy link
Contributor Author

takam5f2 commented Jun 9, 2022

@kenji-miyake
Yes, I tested this PR on CARET_doc and CARET_analysis.

Both worked properly as explained in Description (Sorry, Description is a little messy)

@kenji-miyake
Copy link
Contributor

Cool! Thank you!

@kenji-miyake kenji-miyake merged commit ba750d8 into autowarefoundation:main Jun 9, 2022
@takam5f2 takam5f2 deleted the add-function-to-choose-mkdocs-requirements-txt branch June 9, 2022 08:47
@kenji-miyake
Copy link
Contributor

@takam5f2 Released v1.9.0. https://github.com/autowarefoundation/autoware-github-actions/releases/tag/v1.9.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants