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

Add tag name input to create github release reusable workflow #72

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add tag name input to create github release reusable workflow #72

wants to merge 7 commits into from

Conversation

cenevan
Copy link
Contributor

@cenevan cenevan commented Jul 3, 2024 •
edited by coderabbitai bot
Loading

Description

Added tag name input for reusable-create-release to distinguish between different releases. Updated documentation for several workflows.

Test Plan

Example:

    1. Use different test accounts for login tests, including correct user names and passwords, and incorrect user names and passwords.
    1. ...

Related Issue

Example: Issue #123

Notes

  • Example: Links and navigation need to be added to the front-end interface

Summary by CodeRabbit

  • Documentation

    • Added detailed documentation for reusable secret scanning workflow including triggers, inputs, and required secrets.
    • Introduced documentation for a reusable Go linting workflow including workflow name, triggers, and inputs.
    • Added configuration details for a reusable timestamp workflow in the documentation.

  • Chores

    • Updated release workflow to include a new input parameter tag_to_publish for specifying the tag name to be published.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 3, 2024 •
edited
Loading

Walkthrough

This update introduces new reusable workflow configurations to enhance the automation capabilities in CI/CD processes. We see additions like input parameters for tagging releases, reusable workflows for secret scanning, Go linting, and timestamp management. This streamline workflow setup ensures ease of maintenance and scalability.

Changes

Files Change Summary
.github/workflows/reusable-create-release.yml Added tag_to_publish parameter; modified the jobs' name to include this input value.
docs/security/readme-reusable-secrets-scanning.md Added a new workflow for reusable secret scanning, including details on triggers, inputs, and required secrets.
docs/utility/readme-reusable-lint-go-workflow.md Introduced a reusable Go linting workflow with necessary configurations for triggers and inputs.
docs/utility/readme-reusable-timestamp.md Documented the "Reusable timestamp workflow" with configurations on name, triggers, inputs, and secrets.

In the code where secrets lie,
A workflow scans them nigh,
Tagging releases with a flair,
Lints for Go with greatest care.
Timestamps keep our code in line,
Together, they work just fine.
--Rabbit 💻✨

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Jul 3, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a3f9051 and 3bdfc13.

Files selected for processing (4)
  • .github/workflows/reusable-create-release.yml (2 hunks)
  • docs/security/readme-reusable-secrets-scanning.md (1 hunks)
  • docs/utility/readme-reusable-lint-go-workflow.md (1 hunks)
  • docs/utility/readme-reusable-timestamp.md (1 hunks)
Additional context used
Markdownlint
docs/utility/readme-reusable-lint-go-workflow.md

9-9: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

17-17: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

docs/utility/readme-reusable-timestamp.md

9-9: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

docs/security/readme-reusable-secrets-scanning.md

9-9: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

Additional comments not posted (1)
.github/workflows/reusable-create-release.yml (1)

10-13: Ensure the new input parameter is utilized correctly.

The new input parameter tag_to_publish is introduced. Verify that it is used correctly in the workflow.

docs/utility/readme-reusable-lint-go-workflow.md

## Secrets

- N/A
Copy link

Choose a reason for hiding this comment

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

Fix unordered list indentation.

The unordered list should have consistent indentation.

- - N/A
+ - N/A

Committable suggestion was skipped due to low confidence.

Tools
Markdownlint

17-17: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

docs/utility/readme-reusable-lint-go-workflow.md

## Triggers

- Workflow call
Copy link

Choose a reason for hiding this comment

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

Fix unordered list indentation.

The unordered list should have consistent indentation.

- - Workflow call
+ - Workflow call

Committable suggestion was skipped due to low confidence.

Tools
Markdownlint

9-9: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

docs/utility/readme-reusable-timestamp.md

## Triggers

- Workflow call
Copy link

Choose a reason for hiding this comment

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

Fix unordered list indentation.

The unordered list should have consistent indentation.

- - Workflow call
+ - Workflow call

Committable suggestion was skipped due to low confidence.

Tools
Markdownlint

9-9: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

docs/security/readme-reusable-secrets-scanning.md

## Triggers

- Workflow Call
Copy link

Choose a reason for hiding this comment

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

Fix unordered list indentation.

The unordered list should have consistent indentation.

- - Workflow Call
+ - Workflow Call

Committable suggestion was skipped due to low confidence.

Tools
Markdownlint

9-9: Expected: 0; Actual: 1
Unordered list indentation

(MD007, ul-indent)

coderabbitai[bot]
coderabbitai bot reviewed Jul 4, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3bdfc13 and 70a4393.

Files selected for processing (1)
  • .github/workflows/reusable-create-release.yml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/reusable-create-release.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cenevan