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

feat: add support matrix shortcode #1868

Merged

Conversation

chmouel
Copy link
Member

@chmouel chmouel commented Dec 17, 2024

Changes

Added a support matrix shortcode to the policy guide to indicate which Git providers support specific features. This includes GitHub App, GitHub Webhook, Gitea, GitLab, Bitbucket Cloud, and Bitbucket Server.

Update pull_request default template so that the dev can communicate it in the pull_request.

This is how it is used

{{< support_matrix github_app="true" github_webhook="true" gitea="true" gitlab="false" bitbucket_cloud="false" bitbucket_server="false" >}}

And this is how it will look like

image

Submitter Checklist

  • 📝 Please ensure your commit message is clear and informative. For guidance on crafting effective commit messages, refer to the How to write a git commit message guide. We prefer the commit message to be included in the PR body itself rather than a link to an external website (ie: Jira ticket).

  • ♽ Before submitting a PR, run make test lint to avoid unnecessary CI processing. For an even more efficient workflow, consider installing pre-commit and running pre-commit install in the root of this repository.

  • ✨ We use linters to maintain clean and consistent code. Please ensure you've run make lint before submitting a PR. Some linters offer a --fix mode, which can be executed with the command make fix-linters (ensure markdownlint and golangci-lint tools are installed first).

  • 📖 If you're introducing a user-facing feature or changing existing behavior, please ensure it's properly documented.

  • 🧪 While 100% coverage isn't a requirement, we encourage unit tests for any code changes where possible.

  • 🎁 If feasible, please check if an end-to-end test can be added. See README for more details.

  • 🔎 If there's any flakiness in the CI tests, don't necessarily ignore it. It's better to address the issue before merging, or provide a valid reason to bypass it if fixing isn't possible (e.g., token rate limitations).

Added a support matrix shortcode to the policy guide to indicate
which Git providers support specific features. This includes
GitHub App, GitHub Webhook, Gitea, GitLab, Bitbucket Cloud, and
Bitbucket Server.

Update pull_request default template so that the dev can communicate it
in the pull_request.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
@chmouel chmouel merged commit 44058fd into openshift-pipelines:main Dec 17, 2024
4 checks passed
@chmouel chmouel deleted the feat-add-support-matrix-shortcode branch December 17, 2024 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant