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

Install change log for automated updates #140

Merged
merged 3 commits into from
Jul 3, 2024

Conversation

meritmalling
Copy link
Collaborator

@meritmalling meritmalling commented Jul 3, 2024

Please explain how to summarize this PR for the Changelog:

NA

Tell code reviewer how and what to test:

Once the action is merged creating a new package tag via release should result in a new pr to the guides repo.
Here's an example installed on a dummy package.

  • TODO: NPM_AUTH_TOKEN, CLAUDE_API_KEY, and GH_TOKEN values need to be set for the action to run.

Note: Other actions received an added step to auth them with the changelog package.

Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Walkthrough

The recent updates to the GitHub Actions workflows aim to improve automation and security for the repository. A new workflow for generating changelog updates was introduced, while existing workflows for linting, releasing, and testing were enhanced with steps to authenticate against a private NPM package registry. These changes ensure that automated processes can access necessary private dependencies securely.

Changes

File Path Summary
.github/workflows/cl-create.yml Added a workflow to automate changelog updates based on tag names.
.github/workflows/lint.yml Added a step to authenticate with a private NPM package.
.github/workflows/release.yml Added a step to authenticate with a private NPM package by setting the NPM token.
.github/workflows/test.yml Added a step to authenticate with a private NPM package.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 94093c7 and 5a445fb.

Files ignored due to path filters (3)
  • cl-config.yml is excluded by !**/*.yml
  • package-lock.json is excluded by !**/package-lock.json, !**/*.json
  • package.json is excluded by !**/*.json
Files selected for processing (4)
  • .github/workflows/cl-create.yml (1 hunks)
  • .github/workflows/lint.yml (1 hunks)
  • .github/workflows/release.yml (1 hunks)
  • .github/workflows/test.yml (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • .github/workflows/cl-create.yml
  • .github/workflows/lint.yml
  • .github/workflows/release.yml
  • .github/workflows/test.yml

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.

cl-config.yml Outdated
destinationRepo: 'flatfilers/guides'
destinationDirectory: 'libraries'
packages:
- name: '@flatfile/angular'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Angular is manually deployed at the moment so is actually @flatfile/angular-sdk

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ohh, thank you! Fixing!

Copy link
Collaborator

@bangarang bangarang left a comment

Choose a reason for hiding this comment

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

🚀

@bangarang bangarang force-pushed the feat/add-changelog-automation branch from 99f7acd to a8726ae Compare July 3, 2024 20:32
@meritmalling meritmalling force-pushed the feat/add-changelog-automation branch from a8726ae to 94093c7 Compare July 3, 2024 20:49
Signed-off-by: Merit <merit@flatfile.io>
Signed-off-by: Merit <merit@flatfile.io>
@meritmalling meritmalling force-pushed the feat/add-changelog-automation branch from 94093c7 to 5a445fb Compare July 3, 2024 20:53
@meritmalling meritmalling merged commit 8106bfa into main Jul 3, 2024
2 checks passed
@meritmalling meritmalling deleted the feat/add-changelog-automation branch July 3, 2024 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants