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

Generate API reference docs for Triggers #1298

Merged
merged 1 commit into from
Feb 2, 2022

Conversation

abayer
Copy link
Contributor

@abayer abayer commented Jan 26, 2022

Changes

This will add hack/update-reference-docs.sh to hack/update-codegen.sh, resulting in docs/triggers-api.md being generated.

There probably needs to be a followup in the website repo to actually do something with the reference doc too. =)

/kind documentation

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Release Notes

NONE

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Jan 26, 2022
@abayer
Copy link
Contributor Author

abayer commented Jan 26, 2022

/assign @dibyom

@tekton-robot tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jan 26, 2022
@abayer
Copy link
Contributor Author

abayer commented Jan 26, 2022

/retest

1 similar comment
@abayer
Copy link
Contributor Author

abayer commented Jan 26, 2022

/retest

@@ -0,0 +1,48 @@
{{ define "members" }}
Copy link
Member

Choose a reason for hiding this comment

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

Once we have this in pipelines as well, it would be nice to have this in plumbing and vendor it from there instead of having to do this is each Tekton sub project.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed!

@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 28, 2022
@dibyom
Copy link
Member

dibyom commented Feb 1, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 1, 2022
This will add `hack/update-reference-docs.sh` to `hack/update-codegen.sh`, resulting in `docs/triggers-api.md` being generated.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 1, 2022
@abayer
Copy link
Contributor Author

abayer commented Feb 1, 2022

@dibyom I had to rebase and re-run hack/update-codegen.sh, but it should hopefully be good now. =)

@dibyom
Copy link
Member

dibyom commented Feb 2, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 2, 2022
@tekton-robot tekton-robot merged commit b997365 into tektoncd:main Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants