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

Add inclusive source scanning #6614

Closed
katmutua opened this issue May 2, 2023 · 3 comments · Fixed by #7199
Closed

Add inclusive source scanning #6614

katmutua opened this issue May 2, 2023 · 3 comments · Fixed by #7199
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. Hacktoberfest Categorizes issue as one for Hacktoberfest 2021 help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@katmutua
Copy link
Contributor

katmutua commented May 2, 2023

Describe the solution you would like
We would like to introduce the use of the woke inclusive terminology scan tool, to allow continuous scanning of the TektonCD/pipeline repository to ensure use of inclusive terminology.

The scan target would be the source paths primarily maintained by the TektonCD/pipeline maintainers. Woke makes it easy to scan for code that uses non-inclusive language and suggests alternatives. The tool also allows the configuration of a woke ignore list that allows exclusion of paths that are not primarily maintained by the repository owners/authors.

Added value
Use of inclusive terminology communicates to users, current and potential external contributors of the continuous commitment by repository owners to be inclusive.

Observations (Constraints, Context, etc):
There may be some instances where flagged paths cannot be modified as they could be present in third party libraries, repository names or in OS specific terms e.g. Linux signals like SIGKILL would be flagged without an ignore rule specified.

@afrittoli
Copy link
Member

@tektoncd/core-maintainers

@tekton-robot
Copy link
Collaborator

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 31, 2023
@vdemeester
Copy link
Member

Configured with ignoring the vendor folder (because, it's dependency code, we can't do anything about it), this is the output:

config/dummy.go:1:1-1: Filename finding: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
pkg/reconciler/taskrun/resources/taskref_test.go:174:18-23: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                                                Name:      "dummy",
                                                            ^
pkg/reconciler/taskrun/resources/taskref_test.go:201:13-18: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                                                Name: "dummy-task",
                                                       ^
pkg/reconciler/taskrun/resources/taskref_test.go:322:13-18: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                                                Name: "dummy",
                                                       ^
pkg/reconciler/taskrun/resources/taskref_test.go:345:42-47: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                                        ObjectMeta: metav1.ObjectMeta{Name: "dummy"},
                                                                             ^
pkg/reconciler/taskrun/taskrun_test.go:2834:117-122: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
pkg/reconciler/taskrun/taskrun_test.go:2834:185-190: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
pkg/reconciler/taskrun/taskrun_test.go:3289:44-49: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
    pipeline.tekton.dev/affinity-assistant: dummy-affinity-assistant
                                            ^
pkg/reconciler/pipelinerun/resources/pipelineref_test.go:55:1-6: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
        dummyPipeline = &v1.Pipeline{
        ^
pkg/reconciler/pipelinerun/resources/pipelineref_test.go:57:15-20: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                        Name:      "dummy",
                                    ^
pkg/reconciler/pipelinerun/resources/pipelineref_test.go:114:49-54: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                        pipelines: []runtime.Object{simplePipeline(), dummyPipeline},
                                                                      ^
pkg/reconciler/pipelinerun/resources/pipelineref_test.go:175:3-8: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                        dummyPipeline,
                        ^
pkg/reconciler/pipelinerun/resources/pipelineref_test.go:177:54-59: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                remotePipelines: []runtime.Object{simplePipeline(), dummyPipeline},
                                                                    ^
pkg/reconciler/pipelinerun/resources/pipelineref_test.go:224:59-64: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
        tektonclient := fake.NewSimpleClientset(simplePipeline(), dummyPipeline)
                                                                  ^
pkg/apis/pipeline/v1beta1/resource_types_test.go:24:12-17: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                Image:   "dummy",
                          ^
pkg/apis/pipeline/v1beta1/resource_types_test.go:30:12-17: `dummy` may be insensitive, use `placeholder`, `sample` instead (error)
                Image:   "dummy",
                          ^

/remove-lifecycle stale

@tekton-robot tekton-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 1, 2023
@vdemeester vdemeester added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Aug 4, 2023
@afrittoli afrittoli added the Hacktoberfest Categorizes issue as one for Hacktoberfest 2021 label Oct 4, 2023
prestonvasquez added a commit to prestonvasquez/pipeline that referenced this issue Oct 11, 2023
prestonvasquez added a commit to prestonvasquez/pipeline that referenced this issue Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. Hacktoberfest Categorizes issue as one for Hacktoberfest 2021 help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants