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.

Sign up for GitHub

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

Jump to bottom

CI: remove Documentation Check #2605

Merged
merged 1 commit into from
Oct 18, 2024
+55 −53
Merged

CI: remove Documentation Check #2605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions .github/workflows/documentation-check.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
name: "Documentation Updates"
# name: "Documentation Updates"

on:
pull_request:
paths:
- 'docs/**'
types: [opened, synchronize, labeled]
# on:
# pull_request:
# paths:
# - 'docs/**'
# types: [opened, synchronize, labeled]

push:
branches:
- main
# push:
# branches:
# - main

jobs:
check-docs:
runs-on: ubuntu-latest
# jobs:
# check-docs:
# runs-on: ubuntu-latest

if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-documentation') }}
# if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-documentation') }}

steps:
- name: Checkout repository
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
# steps:
# - name: Checkout repository
# uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4

- name: Set up Go
uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
with:
go-version-file: 'go.mod'
# - name: Set up Go
# uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
# with:
# go-version-file: 'go.mod'

- name: Install tfplugindocs command
run: go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest
# - name: Install tfplugindocs command
# run: go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest

- name: Run tfplugindocs command
run: tfplugindocs generate
# - name: Run tfplugindocs command
# run: tfplugindocs generate

- name: Check for changes
run: |
git diff --exit-code
# - name: Check for changes
# run: |
# git diff --exit-code

- name: Undocumented changes
run: |
echo 'Documentation is not up to date. Please refer to the `Making Changes` in the Contribution Guide on how to properly update documentation.'
exit 1
if: failure()
# - name: Undocumented changes
# run: |
# echo 'Documentation is not up to date. Please refer to the `Making Changes` in the Contribution Guide on how to properly update documentation.'
# exit 1
# if: failure()
44 changes: 23 additions & 21 deletions _about/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you want to learn more about developing a Terraform provider, please refer to

[Install](https://go.dev/doc/install) the version of Golang as indicated in the [go.mod](../go.mod) file.

1. Fork this repo
2. Fork this repo

[Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the provider repository and clone it on your computer.

Expand All @@ -23,7 +23,7 @@ If you want to learn more about developing a Terraform provider, please refer to

From now on, we are going to assume that you have a copy of the repository on your computer and work within the `terraform-provider-kubernetes` directory.

1. Prepare a Kubernetes Cluster
3. Prepare a Kubernetes Cluster

While our preference is to use [KinD](https://kind.sigs.k8s.io/) for setting up a Kubernetes cluster for development and test purposes, feel free to opt for the solution that best suits your preferences. Please bear in mind that some acceptance tests might require specific cluster settings, which we maintain in the KinD [configuration file](../.github/config/acceptance_tests_kind_config.yaml).

Expand Down Expand Up @@ -55,30 +55,32 @@ If you want to learn more about developing a Terraform provider, please refer to
This quick guide covers best practices for adding a new Resource.

1. Ensure all dependncies are installed.
1. Add an SDK Client.
1. Add Resource Schema and define attributes [see Kubernetes Documentation](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs). A best and recommended practice is reuse constants from the Kuberentes packages as a default value in an attribute or within a validation function.
1. Scaffold an empty/new resource.
1. Add Acceptance Tests(s) for the resource.
1. Run Acceptance Tests(s) for this resource.
1. Add Documentation for this resource by editing the `.md.tmpl` file to include the appropriate [Data Fields](https://pkg.go.dev/text/template) and executing `tfplugindocs generate` command [see Terraform PluginDocs](https://github.com/hashicorp/terraform-plugin-docs#data-fields) then inspecting the corresponding `.md` file in the `/docs` to see all changes. The Data Fields that are currently apart of the templates are those for the Schema ({{ .SchemaMarkdown }}), Name ({{ .Name }}) and ({{ .Description }}).
1. Execute `make docs-lint` and `make tests-lint` commands
1. Create a Pull Request for your changes.
2. Add an SDK Client.
3. Add Resource Schema and define attributes [see Kubernetes Documentation](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs). A best and recommended practice is reuse constants from the Kuberentes packages as a default value in an attribute or within a validation function.
4. Scaffold an empty/new resource.
5. Add Acceptance Tests(s) for the resource.
6. Run Acceptance Tests(s) for this resource.
7. Add documentation for this resource in the appropriate `docs/resources/<TYPE>_<VERSION>.go.md` file.
<!-- 7. Add Documentation for this resource by editing the `.md.tmpl` file to include the appropriate [Data Fields](https://pkg.go.dev/text/template) and executing `tfplugindocs generate` command [see Terraform PluginDocs](https://github.com/hashicorp/terraform-plugin-docs#data-fields) then inspecting the corresponding `.md` file in the `/docs` to see all changes. The Data Fields that are currently apart of the templates are those for the Schema ({{ .SchemaMarkdown }}), Name ({{ .Name }}) and ({{ .Description }}). -->
8. Execute `make docs-lint` and `make tests-lint` commands
9. Create a Pull Request for your changes.

### Adding a New Data Source

1. Ensure all dependncies are installed.
1. Add an SDK Client.
1. Add Data Source Schema and define attributes [see Kubernetes Documentation](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs).
2. Add an SDK Client.
3. Add Data Source Schema and define attributes [see Kubernetes Documentation](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs).
A best and recommended practice is reuse constants from the Kuberentes packages as a default value in an attribute or within a validation function.
1. Scaffold an empty/new resource.
1. Add Acceptance Tests(s) for the data source.
1. Run Acceptance Tests(s) for this data source.
1. Add Documentation for this data source by editing the `.md.tmpl` file to include the appropriate [Data Fields](https://pkg.go.dev/text/template) and executing `tfplugindocs generate` command [see Terraform PluginDocs](https://github.com/hashicorp/terraform-plugin-docs#data-fields) then inspecting the corresponding `.md` file in the `/docs` to see all changes. The Data Fields that are currently apart of the templates are those for the Schema ({{ .SchemaMarkdown }}), Name ({{ .Name }}) and ({{ .Description }}).
1. Execute `make docs-lint` and `make tests-lint` commands
1. Create a Pull Request for your changes.

### Adding/Editing Documentation
All Documentation is edited in the `.md.tmpl` file. Please note that the `tfplugindocs generate` command should be executed to ensure it is updated and reflected in the `.md` files.
4. Scaffold an empty/new resource.
5. Add Acceptance Tests(s) for the data source.
6. Run Acceptance Tests(s) for this data source.
7. Add documentation for this data source in the appropriate `docs/data-sources/<TYPE>_<VERSION>.md` file.
<!-- 7. Add Documentation for this data source by editing the `.md.tmpl` file to include the appropriate [Data Fields](https://pkg.go.dev/text/template) and executing `tfplugindocs generate` command [see Terraform PluginDocs](https://github.com/hashicorp/terraform-plugin-docs#data-fields) then inspecting the corresponding `.md` file in the `/docs` to see all changes. The Data Fields that are currently apart of the templates are those for the Schema ({{ .SchemaMarkdown }}), Name ({{ .Name }}) and ({{ .Description }}). -->
8. Execute `make docs-lint` and `make tests-lint` commands
9. Create a Pull Request for your changes.

<!-- ### Adding/Editing Documentation
All Documentation is edited in the `.md.tmpl` file. Please note that the `tfplugindocs generate` command should be executed to ensure it is updated and reflected in the `.md` files. -->

## Testing

Expand Down
Loading