From cc95e24ad384ccb12324957b0674d1d7c5d4eb35 Mon Sep 17 00:00:00 2001 From: Yonatan Koren <10080107+korenyoni@users.noreply.github.com> Date: Mon, 6 Mar 2023 16:00:24 +0200 Subject: [PATCH] Update contributing, PR template. --- .github/PULL_REQUEST_TEMPLATE.md | 1 - CONTRIBUTING.md | 7 +++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 900617e..b3bd799 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,5 +10,4 @@ * [ ] _I have read [CONTRIBUTING.md](https://github.com/codefresh-io/terraform-provider-codefresh/blob/master/README.md)._ * [ ] _I have [allowed changes to my fork to be made](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)._ * [ ] _I have added tests, assuming new tests are warranted_. -* [ ] _I have updated the Terraform docs in this repo, assuming any changes to the schema of Resources or Data Sources have been made._ * [ ] _I understand that the `/test` comment will be ignored by the CI trigger [unless it is made by a repo admin or collaborator](https://codefresh.io/docs/docs/pipelines/triggers/git-triggers/#support-for-building-pull-requests-from-forks)._ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ba7c0f..e1e3a6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,11 @@ The documentation is generated using [tfplugindocs](https://github.com/hashicorp/terraform-plugin-docs). -`docs/` should never be edited by hand. Instead, update the documentation via updating `Description` fields within the `schema` blocks of the provider's resources and data sources. And if needed, update the templates in `templates/`. Finally, you can run the following command to re-generate the documentation: +There is a [GitHub Action Workflow](.github/workflows/docs.yaml) that will automatically update the documentation and commit the changes. This workflow is only triggered when files in `templates/` or files with the `.go` extension are updated. If you suspect that the documentation is out of date, you can comment `/docs` in a PR. + +`docs/` should never be edited by hand. Instead, update the documentation via updating `Description` fields within the `schema` blocks of the provider's resources and data sources. And if needed, update the templates in `templates/`. + +You can always run the following command locally to re-generate the documentation: ```bash make docs @@ -19,5 +23,4 @@ make docs ### PR Requirements 1. Ensure that all tests pass (via commenting `/test` if you are an admin or a contributor with write access on this repo, otherwise wait for a maintainer to submit the comment. The comment will be ignored if you are not an admin or a contributor with write access on this repo. See: https://codefresh.io/docs/docs/pipelines/triggers/git-triggers/#support-for-building-pull-requests-from-forks) -2. Ensure that `make docs` has been run and the changes have been committed. 3. Ensure that `make fmt` has been run and the changes have been committed.