Skip to content

chore: fix docs generation#2538

Merged
chmouel merged 1 commit intotektoncd:mainfrom
chmouel:update-docs-gitignore
Mar 6, 2026
Merged

chore: fix docs generation#2538
chmouel merged 1 commit intotektoncd:mainfrom
chmouel:update-docs-gitignore

Conversation

@chmouel
Copy link
Copy Markdown
Member

@chmouel chmouel commented Mar 5, 2026

📝 Description of the Change

This pull request addresses two main areas:

Fix some golangci-lint errors introced in #2399

Adjust docs/.gitignore:
* The entries content/ALLVERSIONS and content/VERSION have been removed from docs/.gitignore. This change is necessary to allow the
generation of documentation versions.

There was failure in docs generation with:

[unit : upload-release] + echo nightly,stable,v0.42.0,v0.41.1,v0.41.0,v0.40.0,v0.39.5,v0.39.4,v0.39.3,v0.39.2,v0
.39.1,v0.39.0,v0.38.0,v0.37.7,v0.37.6,v0.37.5,v0.37.4,v0.37.3,v0.37.2,v0.37.1,v0.37.0,v0.36.0,v0.35.4,v0.35.3,v0
.35.2,v0.35.1,v0.35.0,v0.34.0,v0.33.2,v0.33.1,v0.33.0,v0.32.0,v0.31.0,v0.30.0,v0.29.1,v0.29.0,v0.28.2,v0.28.1,v0
.28.0,v0.27.3,v0.27.2,v0.27.1,v0.27.0,v0.26.0,v0.25.0,v0.24.7,v0.24.6,v0.24.5,v0.24.4,v0.24.3,v0.24.2,v0.24.1,v0
.24.0,v0.23.0,v0.22.6,v0.22.5,v0.22.4,v0.22.3,v0.22.2,v0.22.1,v0.22.0,v0.21.5,v0.21.4,v0.21.3,v0.21.2,v0.21.1,v0
.21.0,v0.20.0,v0.19.6,v0.19.5,v0.19.4,v0.19.3,v0.19.2,v0.19.1,v0.19.0,v0.18.0,v0.17.7,v0.17.6,v0.17.5,v0.17.4,v0
.17.3,v0.17.2,v0.17.1,v0.17.0,v0.16.0,v0.15.6,v0.15.5,v0.15.4,v0.15.3,v0.15.2,v0.15.1,v0.15.0,v0.14.3,v0.14.2,v0
.14.1,v0.14.0,v0.13.1,v0.13.0,v0.12.0,v0.11.1,v0.11.0
[unit : upload-release] ++ date +%Y%m%d
[unit : upload-release] + echo nightly-ccefffa84-20260305
[unit : upload-release] + git add release.yaml release.k8s.yaml docs/content/VERSION docs/content/ALLVERSIONS pk
g/params/versiondata/version.txt
[unit : upload-release] The following paths are ignored by one of your .gitignore files:
[unit : upload-release] docs/content/ALLVERSIONS
[unit : upload-release] docs/content/VERSION
[unit : upload-release] hint: Use -f if you really want to add them.
[unit : upload-release] hint: Disable this message with "git config advice.addIgnoredFile false"

👨🏻‍ Linked Jira

🔗 Linked GitHub Issue

Fixes #

🧪 Testing Strategy

  • Unit tests
  • Integration tests
  • End-to-end tests
  • Manual testing
  • Not Applicable

🤖 AI Assistance

  • I have not used any AI assistance for this PR.
  • I have used AI assistance for this PR.

If you have used AI assistance, please provide the following details:

Which LLM was used?

  • GitHub Copilot
  • ChatGPT (OpenAI)
  • Claude (Anthropic)
  • Cursor
  • Gemini (Google)
  • Other: ____________

Extent of AI Assistance:

  • Documentation and research only
  • Unit tests or E2E tests only
  • Code generation (parts of the code)
  • Full code generation (most of the PR)
  • PR description and comments
  • Commit message(s)

Important

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer to your commit message.
For example:

Co-authored-by: Gemini gemini@google.com
Co-authored-by: ChatGPT noreply@chatgpt.com
Co-authored-by: Claude noreply@anthropic.com
Co-authored-by: Cursor noreply@cursor.com
Co-authored-by: Copilot Copilot@users.noreply.github.com

**💡You can use the script ./hack/add-llm-coauthor.sh to automatically add
these co-author trailers to your commits.

✅ Submitter Checklist

  • 📝 My commit messages are clear, informative, and follow the project's How to write a git commit message guide. The Gitlint linter ensures in CI it's properly validated
  • ✨ I have ensured my commit message prefix (e.g., fix:, feat:) matches the "Type of Change" I selected above.
  • ♽ I have run make test and make lint locally to check for and fix any
    issues. For an efficient workflow, I have considered installing
    pre-commit and running pre-commit install to
    automate these checks.
  • 📖 I have added or updated documentation for any user-facing changes.
  • 🧪 I have added sufficient unit tests for my code changes.
  • 🎁 I have added end-to-end tests where feasible. See README for more details.
  • 🔎 I have addressed any CI test flakiness or provided a clear reason to bypass it.
  • If adding a provider feature, I have filled in the following and updated the provider documentation:
    • GitHub App
    • GitHub Webhook
    • Gitea/Forgejo
    • GitLab
    • Bitbucket Cloud
    • Bitbucket Data Center

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing development tooling and fixing a documentation build issue. It upgrades the golangci-lint version, leading to minor code style adjustments for consistency and compliance. Additionally, it resolves a critical problem that prevented documentation versions from being generated by modifying the .gitignore file.

Highlights

  • Linting Tool Update: Updated golangci-lint to version 1.26.x, which involved updating the Tekton go.yaml to use docker.io/golang:1.26.0 and making minor code adjustments to comply with stricter linting rules.
  • Error Message Consistency: Adjusted the casing of an error message string (ErrNoFailedPipelineToRetest) to ensure consistent formatting across the codebase.
  • Documentation Generation Fix: Removed content/ALLVERSIONS and content/VERSION from docs/.gitignore to resolve an issue preventing the proper generation of documentation versions.
  • Code Readability Improvements: Applied whitespace and indentation adjustments in several test files to align with project coding standards and improve readability.
Changelog
  • docs/.gitignore
    • Removed content/ALLVERSIONS and content/VERSION entries to enable documentation generation.
  • pkg/hub/tektonhub.go
    • Added a comment to the getSpecificVersion function for clarity.
  • pkg/matcher/annotation_matcher.go
    • Adjusted the casing of the ErrNoFailedPipelineToRetest error message to start with a lowercase letter.
  • pkg/matcher/annotation_matcher_test.go
    • Adjusted indentation within the TestMatchPipelinerunByAnnotation test struct definition.
    • Corrected indentation for wantErr field in a test case.
  • pkg/pipelineascode/match_test.go
    • Modified indentation for fields within the retestAllEvent struct.
    • Updated the expected logSnippet string to match the new error message casing.
Activity
  • The pull request description highlights a previous failure in documentation generation due to docs/content/ALLVERSIONS and docs/content/VERSION being ignored by Git, which this PR aims to fix.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@pipelines-as-code
Copy link
Copy Markdown

pipelines-as-code bot commented Mar 5, 2026

🔍 PR Lint Feedback

Note: This automated check helps ensure your PR follows our contribution guidelines.

⚠️ Items that need attention:

🎫 Jira reference

Add a Jira reference in the description using one of the following formats:

  • https://issues.redhat.com/browse/SRVKP-<number>

If no SRVKP ticket exists yet, link a GitHub issue instead (e.g., Fixes #123).
Minor housekeeping PRs without Jira coverage can skip this after confirming with reviewers.


🤖 AI attribution

The following commits lack an explicit AI attribution footer:

  • 1657238 chore: don't set VERSION in gitignore

If no AI assistance was used for a commit, you can ignore this warning.
Otherwise add an Assisted-by: or Co-authored-by: footer referencing the AI used.


ℹ️ Next Steps

  • Review and address the items above
  • Push new commits to update this PR
  • This comment will be automatically updated when issues are resolved
🔧 Admin Tools (click to expand)

Automated Issue/Ticket Creation:

  • /issue-create - Generate a GitHub issue from this PR content using AI
  • /jira-create - Create a SRVKP Jira ticket from this PR content using AI

⚠️ Important: Always review and edit generated content before finalizing tickets/issues.
The AI-generated content should be used as a starting point and may need adjustments.

These commands are available to maintainers and will post the generated content as PR comments for review.

🤖 This feedback was generated automatically by the PR CI system

@chmouel chmouel changed the title Update docs and fix golangci-lint on previous commit chore: fix docs generation and bump golangci-lint Mar 5, 2026
@pipelines-as-code pipelines-as-code bot added cleanup dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation labels Mar 5, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates golangci-lint and applies the resulting linting fixes. My main feedback is regarding a change to a user-facing error message string. While the change makes it compliant with a linting rule, the new formatting degrades readability. I've suggested reverting this specific change and using a nolint directive to preserve the user experience.

Copy link
Copy Markdown
Member

@theakshaypant theakshaypant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description states

The Tekton go.yaml has been updated to use docker.io/golang:1.26.0.

The said changes have not been checked in.

@chmouel chmouel force-pushed the update-docs-gitignore branch from 8673a6b to 3d741e6 Compare March 5, 2026 13:48
@chmouel chmouel force-pushed the update-docs-gitignore branch from 83d3444 to 3a20e64 Compare March 5, 2026 15:12
@chmouel chmouel changed the title chore: fix docs generation and bump golangci-lint chore: fix docs generation Mar 5, 2026
@chmouel chmouel force-pushed the update-docs-gitignore branch from 3a20e64 to 8c86179 Compare March 5, 2026 15:16
@theakshaypant
Copy link
Copy Markdown
Member

I pushed the golangci changes with ghe fix, pre-commit was failing without them.

@chmouel
Copy link
Copy Markdown
Member Author

chmouel commented Mar 6, 2026

i think we can merge this, it seems we have interminent issue on our gitlab instance :(

setup.go:76: Error deleting GitLab project 937: Delete "https://gitlab.pipelinesascode.com/api/v4/projects/937": read tcp 10.1.0.240:46228->172.67.220.46:443: read: connection reset by peer

we need to generate the docs versions.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
@chmouel chmouel force-pushed the update-docs-gitignore branch from c1ab82e to 1657238 Compare March 6, 2026 07:51
@chmouel chmouel merged commit ba3299c into tektoncd:main Mar 6, 2026
10 of 14 checks passed
@chmouel chmouel deleted the update-docs-gitignore branch March 6, 2026 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants